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.876.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 712dd4c3f316aeec833576d7ce0a8cfdd65bd76b94f425f8315212def65295b9 |
|
MD5 | 70bda25ec6462322f3e29fc0a7534d0e |
|
BLAKE2b-256 | 77b2147e0d7c210bcb46b4a77ede11f4f65b91cf4d7c5c3d0c93ed7e48c1a5b5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.876-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f9cc6ca5c48d49eae83af8feead4bc8d12d377ce3ae6673565f732a55f10896 |
|
MD5 | f807cc50c83063a4b091b01e911c2d2d |
|
BLAKE2b-256 | 7314f8184789e9f3e24cdc92c3fb565c1fbade2c80b8eb37aad987da751fd6dc |