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.517.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93e4268c2dc9d0795f174c28c29146174d6abe1b34f043106ea2268bc041ce5f |
|
MD5 | 3476ab662dc5b499829cde51ddbb419f |
|
BLAKE2b-256 | 344bc6330cb2456d7df914df0b28510908b0198f0ee50b3b30659cd477d052e9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.517-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f629826e67c67006df68575edec91f3f04a656258061cbdf83b6c025586a462b |
|
MD5 | 25e7cc1355c02b130cbd494d1042cfc6 |
|
BLAKE2b-256 | 14ea611653403befe3b0e7f5cb5ee2909f8af633df0b02cd13621e451ddc22bc |