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.363.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a11fa7122ef805242d72a45469988ece5397e3aee94578a2a714d9fee0b2a30 |
|
MD5 | 880390a9a677a425baf7625ad9c34186 |
|
BLAKE2b-256 | 7eb0192097d9155440c2e9cb434deba38718e0dcf8371076f277a503d955a86d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.363-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17ae12126592eb05ad3061abf064b993e0a7a9f7f440ea266ba050d5f7d01308 |
|
MD5 | 02d6114a258d575f15e1a65ec3af8914 |
|
BLAKE2b-256 | b6fc728cbcde4132478ffb3901a2f1b7119f686ace604417e4e23662354277e3 |