mirror of
https://gitea.com/mcereda/oam.git
synced 2026-02-09 05:44:23 +00:00
chore(kb/swagger-ui): start article
This commit is contained in:
70
knowledge base/swagger-ui.md
Normal file
70
knowledge base/swagger-ui.md
Normal file
@@ -0,0 +1,70 @@
|
||||
# Swagger UI
|
||||
|
||||
> TODO
|
||||
|
||||
Intro
|
||||
|
||||
<!-- Remove this line to uncomment if used
|
||||
## Table of contents <!-- omit in toc -->
|
||||
|
||||
1. [TL;DR](#tldr)
|
||||
1. [Further readings](#further-readings)
|
||||
1. [Sources](#sources)
|
||||
|
||||
## TL;DR
|
||||
|
||||
<details>
|
||||
<summary>Setup</summary>
|
||||
|
||||
```sh
|
||||
docker pull 'docker.swagger.io/swaggerapi/swagger-ui'
|
||||
|
||||
docker run -p '8080:8080' 'docker.swagger.io/swaggerapi/swagger-ui'
|
||||
docker run -p '8080:8080' -e 'SWAGGER_JSON_URL=https://example.org/api.json' 'docker.swagger.io/swaggerapi/swagger-ui'
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<!-- Uncomment if used
|
||||
<details>
|
||||
<summary>Usage</summary>
|
||||
|
||||
```sh
|
||||
```
|
||||
|
||||
</details>
|
||||
-->
|
||||
|
||||
<!-- Uncomment if used
|
||||
<details>
|
||||
<summary>Real world use cases</summary>
|
||||
|
||||
```sh
|
||||
```
|
||||
|
||||
</details>
|
||||
-->
|
||||
|
||||
## Further readings
|
||||
|
||||
- [Website]
|
||||
- [Codebase]
|
||||
|
||||
### Sources
|
||||
|
||||
- [Documentation]
|
||||
|
||||
<!--
|
||||
Reference
|
||||
═╬═Time══
|
||||
-->
|
||||
|
||||
<!-- In-article sections -->
|
||||
<!-- Knowledge base -->
|
||||
<!-- Files -->
|
||||
<!-- Upstream -->
|
||||
[codebase]: https://github.com/swagger-api/swagger-ui
|
||||
[documentation]: https://swagger.io/docs/open-source-tools/swagger-ui/usage/installation/
|
||||
[website]: https://swagger.io/tools/swagger-ui/
|
||||
|
||||
<!-- Others -->
|
||||
Reference in New Issue
Block a user