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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b86b22c895e23ea8c36959daa538f4a38aa024df0d14422be104a7c1476830a6 |
|
MD5 | e7704f388e3ed34daa8a9de47a2d4480 |
|
BLAKE2b-256 | f9a50935d2e8d8b6340e1f935298958f5932ea03265fb6791ed6ae89f3ddb143 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30cac25a5007896ebe31b1bbf7fd9edb2205f53e8ebb86ae68490987065dd18e |
|
MD5 | 31376f48a4f492d2e2f6ee8efc765bbc |
|
BLAKE2b-256 | e953627b289aaee4d006f82de1cbe9e81bef4144ddc01289bf5afabfae954a98 |