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.121.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9006b6209334a1bdb66c75fb8e4879032c2d1a511b8e8ebbcd8ab7f06ecae69 |
|
MD5 | 4d9cfc54e13c53ab968b3ec3cdaa8c0b |
|
BLAKE2b-256 | d9b92230219bdaf40b030c1ec138d0f808617b76f7e8fa1d0a189a07f4f859a9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.121-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 429ea865c127f7406580690d0d6d240734e8c84adbc362e7e8167649ee97a6c5 |
|
MD5 | f5c5448b087e008211c574b6ae340edd |
|
BLAKE2b-256 | edd9a1cbfba89ed95beaa3298b0bb8c76eeaaabab596d5b16bbb87754ab7d340 |