https://github.com/arpitbhalla/api-to-readme
Script to insert REST API endpoints to README.md
https://github.com/arpitbhalla/api-to-readme
api arpitbhalla hacktoberfest readme rest-api scripts
Last synced: 5 months ago
JSON representation
Script to insert REST API endpoints to README.md
- Host: GitHub
- URL: https://github.com/arpitbhalla/api-to-readme
- Owner: arpitBhalla
- License: mit
- Created: 2021-08-13T14:51:15.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-07T16:20:24.000Z (over 4 years ago)
- Last Synced: 2024-08-09T12:19:49.739Z (over 1 year ago)
- Topics: api, arpitbhalla, hacktoberfest, readme, rest-api, scripts
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/api-to-readme
- Size: 312 KB
- Stars: 19
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API To README
Script to insert REST API endpoints to README.md
    
---
## :rocket: Getting Started
### Install
```bash
npm install api-to-readme
```
### Usage
```js
/scripts/generateAPI.js
// ES5
const { makeReadme } = require('api-to-readme')
// Typescript
import { makeReadme, API } from 'api-to-readme'
const apis: API[]= [
{
name: "Search",
description: "Search for user",
endpoint: "/search/",
method: "GET",
queryString: [
{
type: "string",
name: "q",
description: "Search query",
required: true,
},
],
response: {
code: 200,
posts: [
{
name: "string",
},
{
name: "string",
},
],
},
},
]
makeReadme(apis, {
readmePath: path.join(__dirname, "README.md"),
startComment: "api-start",
endComment: "api-end",
})
```
### Run
```bash
# run the script
node scripts/generateAPI.js
```
### **Before**
```md
/README.md
# My Awesome Project
...
## API Reference
...
```
### **After**
````md
/README.md
# My Awesome Project
...
## API Reference
### **Search**
Search for user
| Parameter | Type | Description |
| --------- | -------- | ------------------------- |
| `q` | `string` | **Required** Search query |
```http
GET /search/
```
- Response
```json
{
"code": 200,
"posts": [
{
"name": "string"
},
{
"name": "string"
}
]
}
```
...
````
## :checkered_flag: Contribution
```bash
# Clone this project
$ git clone https://github.com/arpitBhalla/api-to-readme
# Access
$ cd api-to-readme
# Install dependencies
$ npm install
# Start contribution
```
## :memo: License
This project is under license from MIT. For more details, see the [LICENSE](LICENSE.md) file.
Made with :heart: by Arpit Bhalla
## Author
**Arpit Bhalla**
- Website: [arpitbhalla.me](https://arpitbhalla.vercel.app/)
- GitHub: [arpitBhalla](https://github.com/arpitbhalla/)
- LinkedIn: [arpitbhalla](https://linkedin.com/in/arpitbhalla/)