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.640.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50669195d49e72d914e50187104bb78bc63e650c6a79858ca3a1d1a7f7acf51b |
|
MD5 | d75d7e4b97729991baf59f174ea04aff |
|
BLAKE2b-256 | 1baf4053efcb71c2b7ccaa9c9847bcca4d74d815979539689e2f7ed14636a57f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.640-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a1d06f1a97c67bcb438f9080acdd3c358de0a27e230bb2253aff8a3b4ff1522 |
|
MD5 | bebd584841ff208ef292f410e47c1f99 |
|
BLAKE2b-256 | 1f3405ae465a35362303a0b53ac98f601e45f63936eae1a5093091fe2093d1e9 |