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.926.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd7bb663903f01c818bf53a32e2ec66b7e71c24dce346690513b724d9b43b0a7 |
|
MD5 | 842ce2bdfd6147bdf5247c495c3f88f4 |
|
BLAKE2b-256 | cc9d0f2e64c42c4583e708c7854a346dfa73e5582901b8ebe2d7d9bc41f0fa7b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.926-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15c7c050ba7b0e697b5927d898bc07654212561ce406c53ae477fb8f191c2225 |
|
MD5 | f130df9adfc9352d5715a1365d00ed93 |
|
BLAKE2b-256 | 22afeb6c2c032fd7b139aa6c41c1bc32ff604179426704b3beb74557e239d546 |