Skip to content

Instantly share code, notes, and snippets.

@hochun836
Last active July 24, 2022 09:35
Show Gist options
  • Select an option

  • Save hochun836/130b0671ea38074a372ee56d3c8a2ee4 to your computer and use it in GitHub Desktop.

Select an option

Save hochun836/130b0671ea38074a372ee56d3c8a2ee4 to your computer and use it in GitHub Desktop.
# base
Swagger // tools from SmartBear Software corp.
OpenAPI // the Swagger project was donated to the OpenAPI Initiative in 2015 and has since been referred to as OpenAPI
OAI (OpenAPI Initiative)
OAS (OpenAPI Specification) // previously known as Swagger Specification
Definition // ex. swagger.json, swagger.yaml
Document // generated by swagger.json (Definition)
# Specification
Swagger v2
OpenAPI v3
=> ref: https://liqiang.io/post/openapi-30-vs-swagger-20
# tools
Swagger Editor
Swagger Codegen
Swagger UI
SwaggerHub
------------------ -------------------
| swagger editor | ---------------> ----------> | swagger codegen |
------------------ ---------------- -------------------
| swagger.json |
-------------------- ---------------- --------------
| language package | -------------> ----------> | swagger ui |
-------------------- --------------
# aspnetcore
Swashbuckle.AspNetCore (https://github.com/domaindrivendev/Swashbuckle.AspNetCore)
NSwag.AspNetCore (https://github.com/RicoSuter/NSwag)
=> ref: https://docs.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger
# [note] what is Redoc
Redoc is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions
live demo: https://redocly.github.io/redoc/
=> ref: https://github.com/Redocly/redoc
# [note] learn
=> ref: https://blog.miniasp.com/post/2019/12/21/ASP%E2%80%A4NET-Core-3-NSwag-OpenAPI-v3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment