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.102.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 429d61724f26fc9e4655081a20091dffd2005c4a7cda55436c323238ad6705af |
|
MD5 | db950a1699b233a334d16c6471ae1dcc |
|
BLAKE2b-256 | 9b3b9c64cdac59a3a94e760f1a698e29870b71ebcccd79de51515b368ebff951 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.102-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39905573e907b97acc527e77239480d01d167bc4b46ecf7074e7896b60b876fb |
|
MD5 | caaf5cbae51d4c0d46681f3185d0bb6c |
|
BLAKE2b-256 | 3bf945ea429cf7d16af449b826c1be522feb119c8ee0a80e39abdc2efd7e7aa0 |