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.131.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce33770ddf602f0e638e1cdb9810ca58d3fb71f5b0c1bce66904a9095e228c1e |
|
MD5 | 8b6d4238e7cd2632c2d0c16b73696982 |
|
BLAKE2b-256 | 0452cda7a529225cfb07e5208e386ca2aa6c16e367c61572b8b4171a9c79aae0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.131-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69d8ff5f3d0a04d7a830e4f2b359173c5b5c0bad2e22262c3237e5a9597a8d7a |
|
MD5 | 602542faed83611d37288eb1f4869c57 |
|
BLAKE2b-256 | 26005c3e73139e67e649271df3c8f08b9f5ce6e9c59415a325ef27398e722e78 |