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.124.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d1e892a5ff6beeb876ac771faf3c4c84b5659220304081346d2f65e1798057f |
|
MD5 | 07d87de64fbc0f0bd31aec4291ff41ce |
|
BLAKE2b-256 | 3846328f1b7b7062fea760a994d26f0871284500b22a180ffbafc8795857d202 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.124-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d89e021880782c7490efb6038bccb513caff12353e9ed1c50c4e7ed632a8b7b2 |
|
MD5 | c0bdef8d7977e1bbdd231dde35f71970 |
|
BLAKE2b-256 | 8ee56c7f0c35fd633bd264f188224a3fabd9337f4b62bfd223005d6399deb4ee |