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.153.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 77d3215c2599e77d121d21fb32ec3bc0106706d7ad7ba3bbbb3d3b5c59b1871c |
|
MD5 | ee517e696b8eeab4915f34fb2e35f855 |
|
BLAKE2b-256 | 0c642ee0ca2d8d022e6271b1ec5796ab28c7573ad402223de1fcc2245a8d11cc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.153-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd32a64a008b183be28484e270f6b2593d1b3a571955fdaf6c22b8bed59570c6 |
|
MD5 | 6b403fc42903606cc0e2ded58681f9d3 |
|
BLAKE2b-256 | 5eb7290c2c793eef9812a7789fd6793c4777c13453c019237eb99e20d8adafe2 |