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.332.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce8b26b6716cc1a62232e9b04e9119a520b423c7b6097196b71156f8eccff369 |
|
MD5 | 05877598f1ca248c02e010dc41c66d73 |
|
BLAKE2b-256 | 7cc2fa80b36a13bf40869827650e9be315164db014eb3998b264bd5d8f7fb167 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.332-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0006aef4d79d1a240faa5a20b51f03bed881ff43312a949263fadc9b6b04f0ff |
|
MD5 | dc86783622ae4361493b4335f7ff94be |
|
BLAKE2b-256 | fc905004a70633ff9dac45e28f1b6e9a94a00ad9c892c80ee3504a86907fa6bd |