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.625.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86da46ce420c9db01dee9bd0f48c5ec4ef9394f02e5efe6e9541b87f618a9faa |
|
MD5 | e28a07f4c25cf07199477106e37fda95 |
|
BLAKE2b-256 | 52e6bc9fa90273c3877ad7ac4980cd349fef4ece4a1e6db0c7cd52a6f10f9ef2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.625-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eae5e58d45c1b32b55e0d6e8fd9cde6ec4a029ceb8972e9e1fd1a0b2e872088a |
|
MD5 | 55c2c7f3d2c9f62cbca790d18816f637 |
|
BLAKE2b-256 | 77fb73fe78af1e88c3424e1fd65be8b9717013536c7c1fed26773e606e210d7c |