UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 5.76 kB
{"openapi":"3.0.0","info":{"contact":{"email":"founders@apis.guru","name":"APIs.guru","url":"http://APIs.guru"},"description":"Wikipedia for Web APIs. Repository of API specs in OpenAPI(fka Swagger) 2.0 format.\n\n**Warning**: If you want to be notified about changes in advance please subscribe to our [Gitter channel](https://gitter.im/APIs-guru/api-models).\n\nClient sample: [[Demo]](https://apis.guru/simple-ui) [[Repo]](https://github.com/APIs-guru/simple-ui)\n","license":{"name":"CC0 1.0","url":"https://github.com/APIs-guru/openapi-directory#licenses"},"title":"APIs.guru","version":"2.0.1","x-apisguru-categories":["open_data","developer_tools"],"x-logo":{"url":"https://apis.guru/branding/logo_vertical.svg"},"x-origin":[{"format":"swagger","url":"https://api.apis.guru/v2/swagger.json","version":"2.0"}],"x-providerName":"apis.guru","x-tags":["API","Catalog","Directory","REST","Swagger","OpenAPI"]},"externalDocs":{"url":"https://github.com/APIs-guru/openapi-directory/blob/master/API.md"},"security":[],"tags":[{"description":"Actions relating to APIs in the collection","name":"APIs"}],"paths":{"/list.json":{"get":{"description":"List all APIs in the directory.\nReturns links to OpenAPI specification for each API in the directory.\nIf API exist in multiple versions `preferred` one is explicitly marked.\n\nSome basic info from OpenAPI spec is cached inside each object.\nThis allows to generate some simple views without need to fetch OpenAPI spec for each API.\n","operationId":"listAPIs","responses":{"200":{"description":"OK","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/APIs"}},"application/json":{"schema":{"$ref":"#/components/schemas/APIs"}}}}},"summary":"List all APIs","tags":["APIs"]}},"/metrics.json":{"get":{"description":"Some basic metrics for the entire directory.\nJust stunning numbers to put on a front page and are intended purely for WoW effect :)\n","operationId":"getMetrics","responses":{"200":{"description":"OK","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Metrics"}},"application/json":{"schema":{"$ref":"#/components/schemas/Metrics"}}}}},"summary":"Get basic metrics","tags":["APIs"]}}},"servers":[{"url":"https://api.apis.guru/v2/"}],"components":{"schemas":{"API":{"additionalProperties":false,"description":"Meta information about API","properties":{"added":{"description":"Timestamp when the API was first added to the directory","format":"date-time","type":"string"},"preferred":{"description":"Recommended version","type":"string"},"versions":{"additionalProperties":{"$ref":"#/components/schemas/ApiVersion"},"description":"List of supported versions of the API","minProperties":1,"type":"object"}},"required":["added","preferred","versions"],"type":"object"},"APIs":{"additionalProperties":{"$ref":"#/components/schemas/API"},"description":"List of API details.\nIt is a JSON object with API IDs(`<provider>[:<service>]`) as keys.\n","example":{"googleapis.com:drive":{"added":"2015-02-22T20:00:45.000Z","preferred":"v3","versions":{"v2":{"added":"2015-02-22T20:00:45.000Z","info":{"title":"Drive","version":"v2","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-logo":{"url":"https://api.apis.guru/v2/cache/logo/https_www.gstatic.com_images_icons_material_product_2x_drive_32dp.png"},"x-origin":{"format":"google","url":"https://www.googleapis.com/discovery/v1/apis/drive/v2/rest","version":"v1"},"x-preferred":false,"x-providerName":"googleapis.com","x-serviceName":"drive"},"swaggerUrl":"https://api.apis.guru/v2/specs/googleapis.com/drive/v2/swagger.json","swaggerYamlUrl":"https://api.apis.guru/v2/specs/googleapis.com/drive/v2/swagger.yaml","updated":"2016-06-17T00:21:44.000Z"},"v3":{"added":"2015-12-12T00:25:13.000Z","info":{"title":"Drive","version":"v3","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-logo":{"url":"https://api.apis.guru/v2/cache/logo/https_www.gstatic.com_images_icons_material_product_2x_drive_32dp.png"},"x-origin":{"format":"google","url":"https://www.googleapis.com/discovery/v1/apis/drive/v3/rest","version":"v1"},"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"drive"},"swaggerUrl":"https://api.apis.guru/v2/specs/googleapis.com/drive/v3/swagger.json","swaggerYamlUrl":"https://api.apis.guru/v2/specs/googleapis.com/drive/v3/swagger.yaml","updated":"2016-06-17T00:21:44.000Z"}}}},"minProperties":1,"type":"object"},"ApiVersion":{"additionalProperties":false,"properties":{"added":{"description":"Timestamp when the version was added","format":"date-time","type":"string"},"externalDocs":{"description":"Copy of `externalDocs` section from Swagger spec","minProperties":1,"type":"object"},"info":{"description":"Copy of `info` section from Swagger spec","minProperties":1,"type":"object"},"swaggerUrl":{"description":"URL to Swagger spec in JSON format","format":"url","type":"string"},"swaggerYamlUrl":{"description":"URL to Swagger spec in YAML format","format":"url","type":"string"},"updated":{"description":"Timestamp when the version was updated","format":"date-time","type":"string"}},"required":["added","updated","swaggerUrl","swaggerYamlUrl","info"],"type":"object"},"Metrics":{"additionalProperties":false,"description":"List of basic metrics","example":{"numAPIs":238,"numEndpoints":6448,"numSpecs":302},"properties":{"numAPIs":{"description":"Number of APIs","minimum":1,"type":"integer"},"numEndpoints":{"description":"Total number of endpoints inside all specifications","minimum":1,"type":"integer"},"numSpecs":{"description":"Number of API specifications including different versions of the same API","minimum":1,"type":"integer"}},"required":["numSpecs","numAPIs","numEndpoints"],"type":"object"}}}}