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.554.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f06d20b7b150f471d4aac9b8de79e6253520ba0fb41cd51864c9e7cc533b88b4 |
|
MD5 | 70334f4332c15f3faec4fa4aea25de71 |
|
BLAKE2b-256 | d86d02b81d84981ff8b14af50c0912de42a44fdab5a1be366d3fc3a7971dd60e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.554-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 32d7f1cf9aaed7c2a3172165b73f55d980d7278763c880e68dc070b427ccb562 |
|
MD5 | 1a5bccd116c13d6877dd9e04e8d7db14 |
|
BLAKE2b-256 | c50fa55dfe0f195a53b25eeb489b63c5b740c10dc98bf68a5c6c644a269be279 |