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.122.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf471f4315c37c3642801390414e425216b39a6c0b07bb5b9616b992a400f740 |
|
MD5 | aae868fc3016f7c1c64da120ea56cf73 |
|
BLAKE2b-256 | 64412c41e3f5edb8892ec6d0aee97d910a2d1a13bc79e3ca9dbcb58db57c5335 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.122-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ee96340070d469145144390fd345f1cea038f5b88ebafdf115da2182fda659a |
|
MD5 | e410f7f0f5aa9b38ba85d670451a9683 |
|
BLAKE2b-256 | 61b790e7d3be09472aa14679c390033f4c90b6aac4d882e720553046f45753b9 |