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.570.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10521f360b0fe20cf35f9a2b2add4bd0b4eb5e7c4a11e1934033b2c666025af5 |
|
MD5 | 3b186ba97d3bfc719c7eb8f4159126b4 |
|
BLAKE2b-256 | f910525e5e10c4ebfcf743e9e71889e3d4ebd4c13453966632694fa5ac363e70 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.570-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7be41a5d34fc53e91639041a77295a9ae1a46f17a241a6960cdc2e610877e32 |
|
MD5 | fad91c01deca8850fa7297867aa41c69 |
|
BLAKE2b-256 | 273c8f7a9f75f479c2d30b0ddfd0d6d77710152ee37ac6b70e46375463d97157 |