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.399.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8088fd63aed69e4ea6b941ed2d9f97735de564cedaff13bc5c117dbfa213dcd2 |
|
MD5 | 183441c36fea4193a4d88ac42296ed6a |
|
BLAKE2b-256 | e0676ce521fdd6f34778c16f1ef1cacd83e90da855bc672b7a9dfbcddd1b177b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.399-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9bd9a75223cd8c7460dd3d8035066eb05f4bf44977f556b7a3de41eceaa335c8 |
|
MD5 | f29195f06b84c8d142bea0dbc7ee9a25 |
|
BLAKE2b-256 | 702dac96ccd11bb05d2413b4b52a62047a56e6861e04463b84679d11d030c89e |