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.325.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2760808a5b7db4adfac120eb168c7fed73ce011be1e9fa5ff4ad1ad1592bafcc |
|
MD5 | 7720e876f64b07cd10906d7c020c468f |
|
BLAKE2b-256 | 768af54396f3bdbb0220f50ac98d05c32c72bc5775a9ad0e1638b5b1cf5b1c9b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.325-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb7891c7e9454607e4a8dfbe28d54737b6cd69bb319857a445e0cc8f707747e4 |
|
MD5 | e3344f88cb7678e1a802206171ad094f |
|
BLAKE2b-256 | 8fd7ecd15d6e21911113498054cd13bfbf09902fe038faf1ed71923004c64c13 |