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.771.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcb57f152533b18088564bd2bfe8bda2ed3f153d5b26ed5f89a7f28e3bb8e0fa |
|
MD5 | f54e276e5958347222135c6346bb7cd2 |
|
BLAKE2b-256 | c504981c1f26bdae572a294bf7e8a019f254ae068594329d6480421305b9669c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.771-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 867fb74626e07798c6cee05bd84520f5e0d41bc302b19fecbd092786903fb014 |
|
MD5 | 7ed6750feffbf0225a75f7773c5f023b |
|
BLAKE2b-256 | 183fdca275a42e636933678730a6b1fb7f7ef32ce501f295a0e289cdca20d8f2 |