openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 4.34 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"name":"Fun Generators","url":"http://fungenerators.com/"},"description":"Fungenerators name generation API generates random names relevant to the given category. Lots of categories are supported with many variations supported. [Click here to subscribe](http://fungenerators.com/api/namegen/)\n","termsOfService":"https://fungenerators.com/terms","title":"Name Generation API","version":"1.5","x-apisguru-categories":["text"],"x-origin":[{"format":"swagger","url":"https://fungenerators.com/yaml/namegen.yaml","version":"2.0"}],"x-providerName":"fungenerators.com","x-serviceName":"namegen"},"tags":[{"description":"Name Generation API","externalDocs":{"description":"Find out more","url":"http://fungenerators.com/api/namegen/"},"name":"Names"}],"paths":{"/name/categories":{"get":{"description":"Get available name generation categories.","parameters":[{"description":"start","in":"query","name":"start","required":false,"schema":{"type":"integer","format":"integer"}},{"description":"limit","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"integer"}}],"responses":{"200":{"description":"200 response","content":{"application/json":{"examples":{"response":{"value":"{\n \"success\": {\n \"total\": \"37\",\n \"start\": 0,\n \"limit\": 5\n },\n \"contents\": [\n [\n {\n \"name\": \"elf\",\n \"title\": \"Elf Name Generator\",\n \"suggestion_supported\": \"0\",\n \"unisex\": false\n },\n {\n \"name\": \"super-hero\",\n \"title\": \"Superhero Name generator\",\n \"suggestion_supported\": \"0\",\n \"unisex\": true\n },\n {\n \"name\": \"alien\",\n \"title\": \"Alien Name generator\",\n \"suggestion_supported\": \"0\",\n \"unisex\": true\n },\n {\n \"name\": \"dragon\",\n \"title\": \"Dragon Name generator\",\n \"suggestion_supported\": \"0\",\n \"unisex\": true\n },\n {\n \"name\": \"indian\",\n \"title\": \"Indian Name generator\",\n \"suggestion_supported\": \"0\",\n \"unisex\": false\n }\n ]\n ]\n}"}}}}},"401":{"description":"401 response","content":{"application/json":{"examples":{"response":{"value":"{\n \"error\": {\n \"code\": 401,\n \"message\": \"Unauthorized\"\n }\n} "}}}}}},"security":[{"X-Fungenerators-Api-Secret":[]}],"tags":["Names"]}},"/name/generate":{"get":{"description":"Generated names in the given category","parameters":[{"description":"Category to generator names from","in":"query","name":"category","required":true,"schema":{"type":"string","format":"string"}},{"description":"Suggestion string if supported by this category generator.","in":"query","name":"suggest","required":false,"schema":{"type":"string","format":"string"}},{"description":"start. Controls pagination. Relevant only if suggestion is supported","in":"query","name":"start","required":false,"schema":{"type":"integer","format":"integer"}},{"description":"limit. Controls pagination limit. Relevant only if suggestion is supported","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"integer"}},{"description":"Variation if supported ( male/female/any )","in":"query","name":"variation","required":false,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"200 response","content":{"application/json":{"examples":{"response":{"value":"{\n \"success\": {\n \"total\": null,\n \"start\": 0,\n \"limit\": 5\n },\n \"contents\": {\n \"category\": \"ninja\",\n \"names\": [\n \"Snow Strikes\",\n \"Rapid Fall\",\n \"Agile Moon\",\n \"Dreamsign\",\n \"Phantom Fall\"\n ]\n },\n \"copyright\": \"https://fungenerators.com/\"\n}"}}}}},"401":{"description":"401 response","content":{"application/json":{"examples":{"response":{"value":"{\n \"error\": {\n \"code\": 401,\n \"message\": \"Unauthorized\"\n }\n}"}}}}}},"security":[{"X-Fungenerators-Api-Secret":[]}],"tags":["Names"]}}},"servers":[{"url":"https://api.fungenerators.com"},{"url":"http://api.fungenerators.com"}],"components":{"securitySchemes":{"X-Fungenerators-Api-Secret":{"in":"header","name":"X-Fungenerators-Api-Secret","type":"apiKey"}}}}