swagdoc/examples/basic.json

Documentation Generator

{
  "name": "Blog App Documentation",
  "description": "This is the documentation for the blog app.",
  "paths": {
    "/posts": {
    },
    "/posts/:id": {
      "content": "<h3>Details</h3><p>Some details about the posts/:id path. You could add whatever you want here.</p>",
      "actions": [
        {
          "name": "Update post",
          "method": "PUT",
          "description": "Allows someone to update a post.",
          "params": {
            "body": {
              "post": {
                "example": {
                  "title": {
                    "example": "I love chicken.",
                    "type": "Title String",
                    "description": "The post title"
                  },
                  "tags": {
                    "example": ["chicken","love"],
                    "description": "All of the tags for a post"
                  }
                },
                "description": "Data to update on the post"
              }
            },
            "url": {
              "id": {
                "description": "The ID of the post you want to update."
              }
            },
            "query": {
              "comments": {
                "description": "Boolean for whether or not comments should be returned with the response"
              },
              "comments_limit": {
                "description": "The number of comments to return if comments are being returned."
              }
            }
          },
          "responses": [
            {
              "name": "Not found Response",
              "status": 404,
              "body": "Not found"
            },
            {
              "name": "Success Response",
              "status": 200,
              "body": {
                "user": {
                  "description": "The user",
                  "example": {
                    "post": {
                      "example": {
                        "title": {
                          "example": "I love chicken.",
                          "description": "The post title"
                        },
                        "tags": {
                          "example": ["chicken","love"],
                          "description": "All of the tags for a post"
                        }
                      },
                      "description": "Data to update on the post"
                    }
                  }
                }
              }
            }
          ],
          "headers": [
            {
              "key": "Authorization",
              "description": "This token is used to authenticate a user with a request. If it is not attached, there will be no user attached to the request. Note that the token must be prepended with 'Bearer: '",
              "example": "Bearer: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI"
            }
          ]
        },
        {
          "name": "Delete",
          "method": "DELETE",
          "description": "Allows someone to update a post."
        }
      ]
    }
  }
}