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.188.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 986055dc77bb9a960482a8db10f9cc0e9d80e5ec322ab57a65620ff428f7182c |
|
MD5 | c01f78e0796afa1e22462009a9da0b0d |
|
BLAKE2b-256 | 63dac4fe66a8b5dd58876bc2d1a0c6a8420d7cb5d9f93593e8ddad9c6538ff82 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.188-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1984e1a1e7e3d4e2a269fa78d7ebfad8fbf74ace58ebbdcfdb62e9cd7d65082 |
|
MD5 | c6aec4ba3ae2bcded13c38051262c0f6 |
|
BLAKE2b-256 | 305892252015401cad572d0e42298a68332c606554790836712456b812f86db2 |