Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Kangaroux committed May 25, 2021
1 parent d08248e commit 4cb8d79
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

- [Overview](#overview)
- [Use Case](#use-case)
- [Do I Really Need This?](#do-i-really-need-this)
- [Examples](#examples)
- [Usage](#usage)
- [Full Code](#full-code)
Expand All @@ -26,6 +27,12 @@ As a result, you end up with an API that has
1. strict type checking, and
2. can give the client helpful error messages when the request is invalid

## Do I Really Need This?

For something like an API, it's worth asking who is going to be the client that is using the API. Is this an API for your single page app, or are you providing a service and it will be used by other developers?

If the API is "internal" and only used within the context of your site, I don't think it's necessary. But if someone is trying to use your API, I think it's worth having. API documentation is rarely perfect, and giving the client a readable error can help them debug when a request throws a 400 Bad Request.

# Examples

Read below for a quick look at how you can use `go-map-schema`.
Expand Down

0 comments on commit 4cb8d79

Please sign in to comment.