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.604.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4754390b88ef9c62bb961df320b3b2214f0317fdb5674fd45f72704b0f0994b8 |
|
MD5 | f9585bef4c9aff5f078c49b046ae59d6 |
|
BLAKE2b-256 | 01990efb09df2d75835e9e25230660bb60a4deafdf2a83f86baf122b330a04c9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.604-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6153303038014ef99c4f9253ecdf49d53c25fb4d5910072ffea14f662e12ccaf |
|
MD5 | 82bed707aae2a8ab532434fd88df3faa |
|
BLAKE2b-256 | 8f0d28a7a9688aa6ef22c43a5b0038c71e7f82843c806ec0a898acc4543fbdb9 |