Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/serhatci/outline-express-rest-api

An npm package to outline express rest API endpoints and return values in the terminal
https://github.com/serhatci/outline-express-rest-api

express java javascript jest npm-package rest-api

Last synced: 9 days ago
JSON representation

An npm package to outline express rest API endpoints and return values in the terminal

Host: GitHub
URL: https://github.com/serhatci/outline-express-rest-api
Owner: serhatci
License: mit
Created: 2021-07-18T22:48:19.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-07-22T22:08:48.000Z (over 3 years ago)
Last Synced: 2024-09-23T18:38:36.918Z (about 2 months ago)
Topics: express, java, javascript, jest, npm-package, rest-api
Language: JavaScript
Homepage:
Size: 1.07 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[![Build Status](https://travis-ci.com/serhatci/outline-express-rest-api.svg?branch=main)](https://travis-ci.com/serhatci/outline-express-rest-api)
[![Coverage Status](https://coveralls.io/repos/github/serhatci/outline-express-rest-api/badge.svg?branch=main)](https://coveralls.io/github/serhatci/outline-express-rest-api?branch=main)
[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/serhatci/outline-express-rest-api/blob/main/README.md)

# Outline express rest API

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

Install library globally

```bash
npm i outline-express-rest-api -g

```

# Usage

Since library will be installed globally, you can use it with 'npx outline' comment. After outline comment, path of a single route file or folder of route files should be called as below:

```bash
npx outline sample-route-files/customers.js

```

or to summarize all route files in the routes folder:

```bash
npx outline sample-route-files

```

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

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

```

# Output Examples

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

Sample output with '--methods' feature

![alt text](https://github.com/serhatci/outline-express-rest-api/blob/main/sample-outputs/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

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.