How to format Swagger 2.0 text descriptions?

by

Markdown is supported in the Swagger Editor. Below is an example of using Markdown in an OpenAPI (Swagger) document:

swagger: '2.0'
info:
  version: 0.0.0
  title: Markdown 
  description: |
    # Heading

    Text attributes _italic_, *italic*, __bold__, **bold**, `monospace`.

    Horizontal rule:

    ---

    Bullet list:

      * apples
      * oranges
      * pears

    Numbered list:

      1. apples
      2. oranges
      3. pears

    A https://stackoverflow.com/questions/39924144/how-to-format-swagger-2-0-text-descriptions(http://example.com).

    An image:
    ![Swagger logo](https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/favicon-32x32.png)

    Code block:

    ```
    {
      "message": "Hello, world!"
    }
    ```

    Tables:

    | Column1 | Column2 |
    | ------- | --------|
    | cell1   | cell2   |
paths:
  /:
    get:
      responses:
        200:
          description: OK

You can copy and paste the above example to the Swagger Editor to see the output.

More Related Contents:

  1. How can I represent ‘Authorization: Bearer ‘ in a Swagger Spec (swagger.json)
  2. Swagger complex response model with dynamic key value hash maps
  3. Difference between Swagger & HATEOAS
  4. Swagger documentation with JAX-RS Jersey 2 and Grizzly
  5. Swagger UI passing authentication token to API call in header
  6. SOAP vs REST (differences)
  7. What are best practices for REST nested resources?
  8. How can I handle many-to-many relationships in a RESTful API?
  9. How to version REST URIs
  10. How to document dynamic query parameter names in OpenAPI (Swagger)?
  11. XDebug and RESTful server using PHPStorm or POSTman
  12. REST Complex/Composite/Nested Resources [closed]
  13. What is the advantage of using REST instead of non-REST HTTP?
  14. What is REST? Slightly confused [closed]
  15. powershell invoke-restmethod multipart/form-data
  16. Transactions across REST microservices?
  17. Designing URI for current logged in user in REST applications
  18. RESTful Services – WSDL Equivalent
  19. What’s the best RESTful method to return total number of items in an object?
  20. Making a PowerShell POST request if a body param starts with ‘@’
  21. Post a json body with swagger
  22. Spring 4 RestController JSON: characteristics not acceptable according to the request “accept” headers
  23. Swagger: “equivalent path already exists” despite different parameters
  24. Jersey with Struts2 [duplicate]
  25. REST API Authentication
  26. Is That REST API Really RPC? Roy Fielding Seems to Think So
  27. Flutter fetched Japanese character from server decoded wrong
  28. HTTP PATCH support in browsers
  29. VSTS use API to set build parameters at queue time
  30. ‘Best’ practice for restful POST response

Leave a Comment