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.656.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d1b28f1356ddfad7fb7aa20c16daeef88fb4f26c07cf0f441123ab860c6ab10 |
|
MD5 | b49228917b8c84799b9d0deb4a81db58 |
|
BLAKE2b-256 | f515f929e8fb7f47d888543c2fdc7cc60cca5dc735a85661070f6487ffb8ccdf |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.656-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3f36e5ce31659381169a8aefc2719231907e6d631dc18f765c12eac96acebc0 |
|
MD5 | 6def03adee4298e828cc58d1ba2f6f6c |
|
BLAKE2b-256 | 9a64edc9eed977cfd6f3e100749636607094f3cc98de9f4ca842970d3ea388b1 |