Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
serhatci committed Jul 22, 2021
1 parent e30fac4 commit ddd4406
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Expand Up @@ -4,7 +4,9 @@

# Outline express rest API

An npm library to summarize your express rest API endpoints and return values in your terminal
An npm library to summarize your express rest API endpoints with HTTP methods in your terminal.

The additional experimental feature can also help you outline the return values of each end point.

# Installation

Expand All @@ -31,14 +33,28 @@ npx outline sample-route-files

```

# Output Example
If you want also to summarize possible return values of end points, add '--methods' at the end:

```bash
npx outline sample-route-files --methods

```

![alt text](https://github.com/serhatci/outline-express-rest-api/blob/main/example-output/example-output.jpg)
# Output Examples

Sample output
![alt text](https://github.com/serhatci/outline-express-rest-api/blob/main/example-output/sample-output.jpg)

Sample output with '--methods' feature

![alt text](https://github.com/serhatci/outline-express-rest-api/blob/main/example-output/sample-output-with-methods.jpg)

# Future Work

Current version is still limited to fully outline express rest API. Only http methods & route end points & express application methods are summarized.

Improving accuracy of the experimental feature will be the next task.

Outlining of query strings & URL parameters will be included in the next version.

# Licence
Expand Down

0 comments on commit ddd4406

Please sign in to comment.