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.614.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | efd1a1889832c558d8faf8ebe7f4213efe992c113dfc238f7a0579877b0f0be7 |
|
MD5 | c24675b45152e46a00ec42d45caad407 |
|
BLAKE2b-256 | 4c1d3609226b2fe5f0d5f719259ceb3d09e36e1b22d9e578508746939257f866 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.614-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbcd43c57ad09b4b1dc61e45d951b95b0c0bdf77feb75d1f7afec724ed7207ad |
|
MD5 | 7e18b7dc5c463225f22f4fef6496e14f |
|
BLAKE2b-256 | 2ad434bce70b1d1ac319c341d0f847f7a791026a40d3dcfa34a05ea3786cb203 |