search

neomerx / json-api

Framework agnostic JSON API (jsonapi.org) implementation
Apache License 2.0
743 stars 66 forks source link

Documentation #229

Open reefebba opened 5 years ago

reefebba commented 5 years ago

It would be very nice of this package if it has more beginner-friendly and all-covered documentation with examples. However, Thank you, this package is very helpful

neomerx commented 5 years ago

@reefebba Hi, there is a wiki which is intended to provide such information and sample aplication that demonstrate how to work with the library. Also, there is a ton of tests that demonstrate every single aspect of the lib usage (mind you 100% test coverage).

If you haven't seen them, please have a look and drop a few lines with feedback. Is it enough? How easy it understandable for a new user? Do you see any changes that could make it better? Don't hesitate to send a PR or ask a question.

JustSteveKing commented 5 years ago

The examples and documentation provided show a very nice and easy way to use this package, but more indepth API docs could be useful to know what the constrains of the package are. I can kind of dig around and figure it out - but not all developers are going to be comfortable doing this

Doqnach commented 5 years ago

Would love to see some documentation on how to handle a POST/PUT/PATCH with a (new) resource and one with a collection of (new) resources.

neomerx commented 5 years ago

@Doqnach Handling HTTP is out of the project's scope. You can use any framework of your choice to handle HTTP and use the library to encode your models/resources into JSON.

Doqnach commented 5 years ago

@neomerx I understand that since this is a framework agnostic library, that handling that is out of scope.

But I was expecting there to be some way to convert (incoming) JSON to models/resources, and not only the other way around? And do some validation of the payload coming in?