{"id":16537144,"url":"https://github.com/arpitbhalla/api-to-readme","last_synced_at":"2025-10-28T13:31:16.018Z","repository":{"id":57181955,"uuid":"395691508","full_name":"arpitBhalla/api-to-readme","owner":"arpitBhalla","description":"Script to insert REST API endpoints to README.md","archived":false,"fork":false,"pushed_at":"2021-10-07T16:20:24.000Z","size":319,"stargazers_count":19,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-09T12:19:49.739Z","etag":null,"topics":["api","arpitbhalla","hacktoberfest","readme","rest-api","scripts"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/api-to-readme","language":"TypeScript","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/arpitBhalla.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-13T14:51:15.000Z","updated_at":"2023-05-03T10:17:39.000Z","dependencies_parsed_at":"2022-09-14T06:00:21.713Z","dependency_job_id":null,"html_url":"https://github.com/arpitBhalla/api-to-readme","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arpitBhalla%2Fapi-to-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arpitBhalla%2Fapi-to-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arpitBhalla%2Fapi-to-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arpitBhalla%2Fapi-to-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arpitBhalla","download_url":"https://codeload.github.com/arpitBhalla/api-to-readme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219859516,"owners_count":16556035,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","arpitbhalla","hacktoberfest","readme","rest-api","scripts"],"created_at":"2024-10-11T18:34:56.543Z","updated_at":"2025-10-28T13:31:15.637Z","avatar_url":"https://github.com/arpitBhalla.png","language":"TypeScript","readme":"# API To README\r\n\r\nScript to insert REST API endpoints to README.md\r\n\r\n![npm](https://img.shields.io/npm/v/api-to-readme?style=flat-square) ![npm](https://img.shields.io/npm/dm/api-to-readme?style=flat-square) ![NPM](https://img.shields.io/npm/l/api-to-readme?style=flat-square) ![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/api-to-readme?style=flat-square) ![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/api-to-readme?style=flat-square)\r\n\r\n---\r\n\r\n## :rocket: Getting Started\r\n\r\n### Install\r\n\r\n```bash\r\nnpm install api-to-readme\r\n```\r\n\r\n### Usage\r\n\r\n```js\r\n/scripts/generateAPI.js\r\n\r\n// ES5\r\nconst { makeReadme } = require('api-to-readme')\r\n\r\n// Typescript\r\nimport { makeReadme, API } from 'api-to-readme'\r\n\r\nconst apis: API[]= [\r\n  {\r\n    name: \"Search\",\r\n    description: \"Search for user\",\r\n    endpoint: \"/search/\",\r\n    method: \"GET\",\r\n    queryString: [\r\n      {\r\n        type: \"string\",\r\n        name: \"q\",\r\n        description: \"Search query\",\r\n        required: true,\r\n      },\r\n    ],\r\n    response: {\r\n      code: 200,\r\n      posts: [\r\n        {\r\n          name: \"string\",\r\n        },\r\n        {\r\n          name: \"string\",\r\n        },\r\n      ],\r\n    },\r\n  },\r\n]\r\n\r\nmakeReadme(apis, {\r\n  readmePath: path.join(__dirname, \"README.md\"),\r\n  startComment: \"api-start\",\r\n  endComment: \"api-end\",\r\n})\r\n```\r\n\r\n### Run\r\n\r\n```bash\r\n# run the script\r\nnode scripts/generateAPI.js\r\n```\r\n\r\n### **Before**\r\n\r\n```md\r\n/README.md\r\n\r\n# My Awesome Project\r\n\r\n...\r\n\r\n## API Reference\r\n\r\n\u003c!-- api-start --\u003e\r\n\u003c!-- api-end --\u003e\r\n\r\n...\r\n```\r\n\r\n### **After**\r\n\r\n````md\r\n/README.md\r\n\r\n# My Awesome Project\r\n\r\n...\r\n\r\n## API Reference\r\n\r\n\u003c!-- api-start --\u003e\r\n\r\n### **Search**\r\n\r\nSearch for user\r\n\r\n| Parameter | Type     | Description               |\r\n| --------- | -------- | ------------------------- |\r\n| `q`       | `string` | **Required** Search query |\r\n\r\n```http\r\nGET /search/\r\n```\r\n\r\n- Response\r\n\r\n```json\r\n{\r\n  \"code\": 200,\r\n  \"posts\": [\r\n    {\r\n      \"name\": \"string\"\r\n    },\r\n    {\r\n      \"name\": \"string\"\r\n    }\r\n  ]\r\n}\r\n```\r\n\r\n\u003c!-- api-end --\u003e\r\n\r\n...\r\n````\r\n\r\n## :checkered_flag: Contribution\r\n\r\n```bash\r\n# Clone this project\r\n$ git clone https://github.com/arpitBhalla/api-to-readme\r\n\r\n# Access\r\n$ cd api-to-readme\r\n\r\n# Install dependencies\r\n$ npm install\r\n\r\n# Start contribution\r\n\r\n```\r\n\r\n## :memo: License\r\n\r\nThis project is under license from MIT. For more details, see the [LICENSE](LICENSE.md) file.\r\n\r\nMade with :heart: by \u003ca href=\"https://github.com/arpitBhalla\" target=\"_blank\"\u003eArpit Bhalla\u003c/a\u003e\r\n\r\n## Author\r\n\r\n**Arpit Bhalla**\r\n\r\n- Website: [arpitbhalla.me](https://arpitbhalla.vercel.app/)\r\n- GitHub: [arpitBhalla](https://github.com/arpitbhalla/)\r\n- LinkedIn: [arpitbhalla](https://linkedin.com/in/arpitbhalla/)\r\n\r\n\u0026#xa0;\r\n\r\n\u003ca href=\"#top\"\u003eBack to top\u003c/a\u003e\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farpitbhalla%2Fapi-to-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farpitbhalla%2Fapi-to-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farpitbhalla%2Fapi-to-readme/lists"}