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.698.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5254a7b5f0d788390dcb59090fa3cf070659e866d0cc94aef492a1ea1c9eab07 |
|
MD5 | 490bb18231a202807e265fec368bd0ff |
|
BLAKE2b-256 | b0a5528dd10dcda20073c99408107f4f513155dba4db08df4ed1b00a92a75d09 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.698-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a5bf58b98fa8a9f448db23d1b2b08b19b2e8e3a6482e217063b502e47f53711 |
|
MD5 | 510156e375c6ebe1cc2301adbd8fb875 |
|
BLAKE2b-256 | dd8b539179a57215cb06f8b31fb95fb2783b695820e3f1279a8a9d89b769aabd |