{"id":17493582,"url":"https://github.com/nakasar/serverless-api-doc-generator","last_synced_at":"2026-04-28T15:40:46.931Z","repository":{"id":95643031,"uuid":"149720546","full_name":"Nakasar/serverless-api-doc-generator","owner":"Nakasar","description":"Generate Documentation API from serverless.yml and JS docstrings.","archived":false,"fork":false,"pushed_at":"2018-10-23T06:38:15.000Z","size":19,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-23T15:49:26.324Z","etag":null,"topics":["api","documentation-generator","openapi","serverless"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nakasar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-21T06:35:02.000Z","updated_at":"2020-05-16T09:00:13.000Z","dependencies_parsed_at":"2023-03-31T16:47:22.330Z","dependency_job_id":null,"html_url":"https://github.com/Nakasar/serverless-api-doc-generator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Nakasar/serverless-api-doc-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nakasar%2Fserverless-api-doc-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nakasar%2Fserverless-api-doc-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nakasar%2Fserverless-api-doc-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nakasar%2Fserverless-api-doc-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nakasar","download_url":"https://codeload.github.com/Nakasar/serverless-api-doc-generator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nakasar%2Fserverless-api-doc-generator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32387918,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-28T14:34:11.604Z","status":"ssl_error","status_checked_at":"2026-04-28T14:32:37.009Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","documentation-generator","openapi","serverless"],"created_at":"2024-10-19T12:08:43.131Z","updated_at":"2026-04-28T15:40:41.918Z","avatar_url":"https://github.com/Nakasar.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# INSTALLATION\n- clone this repository.\n- enter `npm link` in the root folder.\n- You are done.\n\n# USAGE\n- anywhere, type `generate-doc -i path/to/api/folder -o path/to/out/file.yml`\npath/to/api/folder must contain the serverless.yml definition.\n\n## Options\n- `--server-url \"http://example.com/\"` API base url.\n\n# DOCUMENT ROUTES\n```javascript\n/**\n * Function description\n * @param {Object} event \n * @param {Object} context \n * @apidoc [\n *  description: Route description\n *  tags:\n *    - sometag\n *  parameters:\n *    - name: someParam\n *      in: path\n *      required: true\n *      description: someParam description.\n *      schema:\n *        type: integer\n * ]\n */\nmodule.exports.get = async (event, context) =\u003e {\n\n};\n```  \nOR :\n```javascript\n/** Create a new tag for an offering.\n * @param {ServerlessEvent} event\n * @param {ServerlessContext} context\n * @apidoc [\n *  description: Create a new tag for an offering.\n *  tags:\n *    - tags\n *    - offerings\n *  parameters:\n *    - name: offeringId\n *      in: path\n *      required: true\n *      description: ID of offering.\n *      schema:\n *        type: integer\n *  requestBody:\n *    description: Tag object.\n *    required: true\n *    content:\n *      application/json:\n *        schema:\n *          type: object\n *          properties:\n *            title:\n *              type: string\n *              description: Title of tag.\n *          example:\n *            title: MY_TAG\n *          required:\n *            - title\n *  authorization: user\n *  success:\n *    status: 200\n *    description: Created tag\n *    schema:\n *      type: object\n *      properties:\n *        id:\n *          type: integer\n *          description: Unique ID of tag.\n *        title:\n *          type: string\n *          description: Unique Title of tag.\n *          example: MY_TAG\n *  failure:\n *    409:\n *      description: Tag already defined.\n *      message: This tag already exists for this offering.\n *      type: ConflictError\n *    404:\n *      description: Offering Not found.\n *      message: The offering could not be found.\n *      type: ResourceNotFoundError\n * ]\n */\nasync function createOneForOffering(event, context) {\n\n};\n```  \nOther naming convention of function WILL NOT be computed.\n\nThe generator will automatically add a default and a '2XX' generic response if they are not defined in the @apidoc description.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnakasar%2Fserverless-api-doc-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnakasar%2Fserverless-api-doc-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnakasar%2Fserverless-api-doc-generator/lists"}