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.673.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47412ea750fca4093e16834289b44ed8c97753a9548780f70115205cf23ef7db |
|
MD5 | 0c7ec087f18956e96ad0c1b66e39fee9 |
|
BLAKE2b-256 | c668191510231a1020b2871ebd21fad6c18b9ca7fa1dd8ad08b2f3760f05c929 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.673-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6564e7960f95ac4ce3e829c79ef1b4d03e2f9212bf798796deaa930c390bcc23 |
|
MD5 | 10fdf83e2dddf7ebf2dba46967efdc3d |
|
BLAKE2b-256 | 9c870996e0a3f24bf54586b0c6b8fb2d2604181bd015b2add75026d9589ef68a |