Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hamza-cskn committed Sep 15, 2023
1 parent c738adc commit 073b882
Showing 1 changed file with 3 additions and 11 deletions.
14 changes: 3 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,7 @@ Note: The provided `docker-compose.yml` does not include MongoDB as scaled.
* You can use `curl` or `Postman` to send HTTP requests.
* API Documentation can be found below.

If you know Turkish, feel free to read my [Rest API](https://medium.com/software-development-turkey/rest-api-nedir-standartları-nelerdir-ca1c7d7d0502) blog.

### API
Listing all blogs.
```http request
GET /api/v1/blogs/?limit=1&offset=1&plainText=true&showUnverified=true
#### Postman Collection
The repository has ready-to-use Postman collection. Check `blog-app.postman_collection.json` file or visit the [documentation page](https://documenter.getpostman.com/view/24413595/2s9YC5zDD7).

showUnverified: true | false --- when true, shows unvisible blogs.
plainText: true | false --- when true, shows blog contents without markdown formats.
offset: number --- offset for pagination. skips first n blogs.
limit: number --- limit for pagination. shows n blogs.
```
If you know Turkish, feel free to read my [Rest API](https://medium.com/software-development-turkey/rest-api-nedir-standartları-nelerdir-ca1c7d7d0502) blog.

0 comments on commit 073b882

Please sign in to comment.