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.522.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3bb7803fa3675d0297a9946b9aaebc1ae80e57105f076eb131c9387fadba13e2 |
|
MD5 | 667120021ef55b2e0d9d8d3df25d053b |
|
BLAKE2b-256 | 683e89ee46a6fb3c13d5926b60e26e132dc1cdb4737ef23e2dfe1efda5eb824e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.522-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 328a606efcdff2627c5ba54320c51819752e0e816282a0d37ddb4958f35ebff6 |
|
MD5 | dee32e8466a36cdd6c12818c9fbb78c1 |
|
BLAKE2b-256 | 5281654e9f5cb91bcd170e856973d6ff20446bd493518bf1185127d2f5369843 |