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.79.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a85859ad0c1be7726d951f2212bd7bb7cab529a813875e3e5bd6420dd56232a |
|
MD5 | 9662a4eccb28ae5b5fcd1f42a64f211d |
|
BLAKE2b-256 | 8a47878790c028efcc8863e670e467b2dbef8df0797bd09b948f145c62659055 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.79-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8cbc310d121f236d8a04fd283c8a5dbaec7be36b4435f14dde99d6212128599a |
|
MD5 | fb59137b0d47c474bcb33805aed62031 |
|
BLAKE2b-256 | 79d88400e4bcda4b1d5ce4f66d3eeab40c88cea1026c053700263897a9f1dcb8 |