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.168.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 373fd38cb510703db1d62db1dd1c7957007508f6690c25c85331bcadb16f300a |
|
MD5 | 1bd9d948b303f7bee006b6f474ad5414 |
|
BLAKE2b-256 | 3bbc751781397b55382bee8be2b0e7c16bfcb3af10f17fa9e5b126e651af45fa |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.168-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a3bc405413f2f01770e734368bcfea3ff82da16a83f766e56d62c6d26d7d14a |
|
MD5 | 2a624d9235fc6c3f59290b79afdb16f1 |
|
BLAKE2b-256 | 9e557edf5799186146317f2e72ca6235d339b73b3b4451774a8dfd92435a0034 |