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.497.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 91079b7950688e1a903e512fa1314566a0eee9c529d02bf2c13deea690c5ffb7 |
|
MD5 | 97a860e30e5f230047fdde6b95823e22 |
|
BLAKE2b-256 | a352e372fa44e58e13055d31ddc61855898b3ab4c378b39873635902c6bb022a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.497-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25bb0f21a7b6b51180163518c86ee100ed8c2741de0a308d9ee71e000aa69ae6 |
|
MD5 | 3e985683f4c8b7931702dbca57b07155 |
|
BLAKE2b-256 | 3594b127859f6a1c25fc16f3149a4d10d063a6cb525de591c28ea681d665643c |