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.464.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f82678766815d50d7659a84df40b3c5495d67c6615d9b5c14693b294a1f4112 |
|
MD5 | 7ff24cc446ee655711e9aa2e46323f8a |
|
BLAKE2b-256 | 66f3eb5d413584e86db2ebc227a23bb87dc032d3e8213c301b2b0dbb59752bc8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.464-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9520cfe4517d17cda10364fbfec66f0a74da30a0d8369f37993565cf45d32c1 |
|
MD5 | 006b30f7ba30982a8d34899e9be41b6b |
|
BLAKE2b-256 | 0c47741fe80dae8feb27cc415245a5de3cb72bb3bd12140fbfb478d94ad71057 |