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.180.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46a70ea731f98ac78ffa425b80d8bcf0140649d6ffc0f923592eb5c0db3cc8cc |
|
MD5 | 29cd144c4b222b5d5276137024e9ee57 |
|
BLAKE2b-256 | 41c718d4b90fd16379abac2c203c9ca030d97047b56b20801454e12c10444835 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.180-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e966586575cea8e1b919b8d61cdaf68e66e111fd886af126f592e9e1bbe11d4 |
|
MD5 | 781783ca7c89b12e0fc8557299545bce |
|
BLAKE2b-256 | ff7d8f6ef8aa141cd224525496c8a3b4578bf6abe7ec11e2911e94f66d464be6 |