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.902.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa066d454932c61460772d984d93014c84123b4af07a661b13312c897e828df0 |
|
MD5 | dca51ec29756a25f35fd9a8ff11b6b67 |
|
BLAKE2b-256 | ddebb0d762780ac0f093b4592499859b40fa6b0311085dd9ff09a10d22f77ee9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.902-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47ffbbc4bc694f56a72bd487abb2a421e7694422c7865c3cbd71ff06fc757900 |
|
MD5 | dc25d2a09df66accd178373ce03a46b8 |
|
BLAKE2b-256 | aabc3bf72a766927f104de2774b04b7015b99406273e95f470a6a863a891bc9d |