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.191.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34da7757135027f6b75b3e4bc32bfb2451e4146ee158ee9aa08c1f535a192d5a |
|
MD5 | a0827b194a545b872cc707618639dd27 |
|
BLAKE2b-256 | 8bcb7d7618df5d81be28b06fb13f192a71fe86c5665ad534dc453c8251e1b80b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.191-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 74e82e5dbd067940fa0fd373dedef0d9afe5fe9961ece1f7e03b208d53db30e4 |
|
MD5 | 56dcda7ca5464b5134eae015fa510c59 |
|
BLAKE2b-256 | 42ed17215471400edc7c722da92cf4940c0445af25c93c010db20cb7d208f452 |