https://github.com/beapp/swagger-ui-plugin-wip-operation
Swagger-ui plugin to visually flag some operation as WIP
https://github.com/beapp/swagger-ui-plugin-wip-operation
Last synced: 11 months ago
JSON representation
Swagger-ui plugin to visually flag some operation as WIP
- Host: GitHub
- URL: https://github.com/beapp/swagger-ui-plugin-wip-operation
- Owner: BeApp
- Created: 2021-04-29T20:03:10.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-30T21:03:20.000Z (about 5 years ago)
- Last Synced: 2025-07-24T10:11:19.826Z (11 months ago)
- Language: JavaScript
- Size: 79.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introduction
This [Swagger-UI](https://github.com/swagger-api/swagger-ui) plugin allows to mark some path operation as still Work In Progress.
It works by wrapping the `operation` component with a div and applying custom CSS.
# Installation
```
npm i swagger-ui-plugin-wip-operation
```
# Usage
Add the plugin in the configuration object of SwaggerUI like this :
```js
import { WipOperationPlugin } from 'swagger-ui-plugin-wip-operation';
SwaggerUI({
// ...
plugins: [
WipOperationPlugin
]
})
```
To mark an operation as WIP, you just have to add `x-wip: true` field on your OpenAPI spec :
```yaml
openapi: "3.0.1"
# ...
paths:
/my-wip-endpoint:
get:
x-wip: true
summary: "An endpoint still in specification"
responses:
"200":
description: "Successful operation"
```