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.652.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6111473ce4b47ce1dc036fa33ad0ea36ca423acecb5eec745ef0e96dd45961b5 |
|
MD5 | a0569c3d3281fc6820e4f72981cee1c3 |
|
BLAKE2b-256 | 0b128522bfc862e7c054c0b5b047e83d6d496d87a575478bb4b22700b0c9acd9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.652-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d42b340ae1113e2729ff7cb72d16507cd86d62605572a62b9c783054fb7cb917 |
|
MD5 | d6a8c7ce5381cb0c8489d0322c787c42 |
|
BLAKE2b-256 | 6d9ed3ae4c6a1c0436121326085ef96c852aa9ec6a30a765225e63eab2f75059 |