Amazon API Gateway Importer: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
 
(8 intermediate revisions by the same user not shown)
Line 6: Line 6:


* [[Swagger#Tools|Swagger]]
* [[Swagger#Tools|Swagger]]
* [[Amazon API Gateway#Subjects|Amazon API Gateway]]
* [[Amazon_API_Gateway_Operations#Amazon_API_Gateway_Importer|Amazon API Gateway Operations]]


=Overview=
=Overview=
The tool is a Java equivalent of AWS CLI import/update tools. The tool uses [[Swagger_API_Tools#Swagger_Parser|swagger-parser]], [[Swagger_API_Tools#Swagger_Core|swagger-core]], swagger-models, etc. It does *not* automatically enhance the specification with API Gateway extensions.


=Build and Install=
=Build and Install=
<font color=darkgray>When is this necessary? Build or operations? This tool requires AWS credentials to be configured in at least one of the locations specified by the [https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html default credential provider chain].</font>


  cd .../runtime
  cd .../runtime
Line 19: Line 19:
  mvn assembly:assembly
  mvn assembly:assembly


This creates the binary that parses the Swagger file, injects [[Amazon API Gateway Extension to OpenAPI|AWS API Gateway extensions to OpenAPI]] and creates or updates an API based on the processed specification.
This creates the binary that parses the Swagger file and creates or updates an API based on the specification file.
 
=Execute=
 
This tool requires AWS credentials to be configured in at least one of the locations specified by the [https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html default credential provider chain].
 
./aws-api-import.sh -c .../swagger.json
 
=Debug=
 
./aws-api-import.sh -d -c .../swagger.json

Latest revision as of 21:36, 26 March 2019

External

Internal

Overview

The tool is a Java equivalent of AWS CLI import/update tools. The tool uses swagger-parser, swagger-core, swagger-models, etc. It does *not* automatically enhance the specification with API Gateway extensions.

Build and Install

cd .../runtime
git clone git@github.com:amazon-archives/aws-apigateway-importer.git
cd aws-apigateway-importer
mvn assembly:assembly

This creates the binary that parses the Swagger file and creates or updates an API based on the specification file.

Execute

This tool requires AWS credentials to be configured in at least one of the locations specified by the default credential provider chain.

./aws-api-import.sh -c .../swagger.json

Debug

./aws-api-import.sh -d -c .../swagger.json