Add SwaggerUI to your AWS Apigateway RestApi
Project description
CDK Apigateway SwaggerUI
Add SwaggerUI to your AWS Apigateway RestApi
Install
TypeScript
npm install @pepperize/cdk-apigateway-swagger-ui
or
yarn add @pepperize/cdk-apigateway-swagger-ui
Python
pip install pepperize.cdk-apigateway-swagger-ui
C# / .Net
dotnet add package Pepperize.CDK.ApigatewaySwaggerUi
Java
<dependency>
<groupId>com.pepperize</groupId>
<artifactId>cdk-apigateway-swagger-ui</artifactId>
<version>${cdkApigatewaySwaggerUi.version}</version>
</dependency>
Usage
import { Stack } from "aws-cdk-lib";
import * as apigateway from "aws-cdk-lib/aws-apigateway";
import { SwaggerUi } from "@pepperize/cdk-apigateway-swagger-ui";
const stack = new Stack();
const restApi = new apigateway.RestApi();
new SwaggerUi(stack, "SwaggerUI", { resource: restApi.root });
- Open your SwaggerUI:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs/swagger-ui.html
- View your API docs:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs.json
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for pepperize.cdk-apigateway-swagger-ui-0.0.257.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab8c7b7666f8fe4f86d85836bb264d2651b2aabc89397c01ea151263634de2c7 |
|
MD5 | f757fe0b575ce2527751e5cc7d7446de |
|
BLAKE2b-256 | ea66c0d1fa12441439db6cd8f5f9cbacd9264a3882581c843c33878083a23e90 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.257-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b30a742866999abdc869bba1829ab25ac6e42f5fa7fd9cb1c8e1813fa0243450 |
|
MD5 | c71c2e54513a4f8a08e655a71bcb8412 |
|
BLAKE2b-256 | 66f0f9acb1f4c5cfe2aaf9ffb883033618595c223f873408153813a863dc0e8f |