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.793.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34e21cf77365ce9879ff4f3ec4358c61c0258339c3fb691b783e45c7e182b194 |
|
MD5 | d7f6b4efc71904f052aaa6e87c440b9b |
|
BLAKE2b-256 | 073ba7c1d89e7dcccf45a5808fe1430066edf0d22be327d596bb5e78a7cbdc26 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.793-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f173880b41cf61e59c17d732f8afc5393fefbd85a0f69ae1d4aecb42d598f1cd |
|
MD5 | 337b1241a32db6cf8508d86f945c19fa |
|
BLAKE2b-256 | 0c08ac1fdcf61e194fcc688534c5dfde404fa03a6b7d967b621aeaf2593ba5ed |