{"__v":0,"_id":"588f722bbcace50f0052b9f8","category":{"version":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","_id":"588f722bbcace50f0052b9e3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-12-09T21:22:52.427Z","from_sync":false,"order":1,"slug":"user-guide","title":"Reference"},"parentDoc":null,"project":"565f5fa26bafd40d0030a064","user":"565f5f29de5dc50d00acfe9f","version":{"__v":1,"_id":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","createdAt":"2017-01-30T17:04:43.410Z","releaseDate":"2017-01-30T17:04:43.410Z","categories":["588f722bbcace50f0052b9e2","588f722bbcace50f0052b9e3","588f722bbcace50f0052b9e4","588f722bbcace50f0052b9e5","588f722bbcace50f0052b9e6","588f722bbcace50f0052b9e7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"5.3.0","version":"5.3.0"},"updates":["57e55213f3d7fc0e009c50ef"],"next":{"pages":[],"description":""},"createdAt":"2016-02-16T17:52:46.128Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":11,"body":"Each API you define will automatically get documentation in the form of Swagger Docs. This feature is enabled by default and can be toggled on or off via the API edit page.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a7KIOUouQHncd5fwZYxY_api-edit.png\",\n        \"api-edit.png\",\n        \"1448\",\n        \"730\",\n        \"#6281a4\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nIf you have Swagger Docs enabled, each host for your API will be able to serve up its own Swagger meta data at <host>/swagger.json. You can see an example of what this meta data looks like <a href=\"https://mocks.nanoscaleapi.io/v1/swagger_docs.json\" target=\"_blank\">here</a>. This meta data is used in the admin dashboard to render a Swagger UI for your API.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/H6O860lIRYimRTAqyqcY_docs.png\",\n        \"docs.png\",\n        \"1448\",\n        \"837\",\n        \"#905946\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"api-documentation","type":"basic","title":"API Documentation"}
Each API you define will automatically get documentation in the form of Swagger Docs. This feature is enabled by default and can be toggled on or off via the API edit page. [block:image] { "images": [ { "image": [ "https://files.readme.io/a7KIOUouQHncd5fwZYxY_api-edit.png", "api-edit.png", "1448", "730", "#6281a4", "" ] } ] } [/block] If you have Swagger Docs enabled, each host for your API will be able to serve up its own Swagger meta data at <host>/swagger.json. You can see an example of what this meta data looks like <a href="https://mocks.nanoscaleapi.io/v1/swagger_docs.json" target="_blank">here</a>. This meta data is used in the admin dashboard to render a Swagger UI for your API. [block:image] { "images": [ { "image": [ "https://files.readme.io/H6O860lIRYimRTAqyqcY_docs.png", "docs.png", "1448", "837", "#905946", "" ] } ] } [/block]