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.59.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d0a2de24260215402e81063f269aa929e43afd7db42c8184813138cb1367d65f |
|
MD5 | 08c94e12d7e11ce114824619fbc83381 |
|
BLAKE2b-256 | c23e700109b5e3999cc8e9b373a99c0fd6b70fff25acba3b37013adb7de5b6e7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.59-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e1347e7576cb49f93063e6d80feb058cd247714516538826ba010a1ba90c7d13 |
|
MD5 | f56e274a2f9898d1f151647075d8a957 |
|
BLAKE2b-256 | a07b5a28f30deceec1b7965804dd3e146acf9f95315a6f0c7150628430ca051a |