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.43.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7cce61e23ba327296cafe0824122e438a20ec555eb6b66c349c2ed8e1c31356a |
|
MD5 | a8d36c1ac5ce45ec637825588e618162 |
|
BLAKE2b-256 | 9474f08741ae0cc8a29862a42d3e547120cbb35108bcf888c9bc0812b593ec79 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.43-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9119b77076df57d17c34288be7b9d5b6e00cd0f3757fea21baa35fc47c3d49ca |
|
MD5 | ad39163f79657ea51932e2b89f763c3b |
|
BLAKE2b-256 | 3553c1629c70577f5957c74f68954875adf4231d887238f39a80fcf2ed933200 |