Implemented Suggested 11/18/2022
10
votesConsistent & Developer-Friendly API
The current API is not ideal. It would be nice to see improvements in the following areas:
- Consistent responses. This is turning into a real pain to handle. Right now it returns a JSON object if it's returning a valid object, but in the case of creating a user or such like it returns a plain-text response with just the id in the body. Additionally, and even worse, if an error occurs IT STILL RETURNS 200 OK, but the body of the response will be an error message. There is no easy way to tell if the response is truly successful or if it's a failure without having to parse out the response. It would be much easier to use if a 400, 404, or such like was returned in case of a failure (like a user was not found) and always return JSON when a 200 is returned.
- Allow to be sent to the server in JSON format instead of requiring form-data or query parameters.
- RESTful (or at least REST-like) URLS (e.g. POST /api/users instead of POST /api/CreateUser)
Log in to comment...
Get help for this page
Jitbit HelpDesk
2. We've also added JSON support for someone most used methods (POST ticket, CreateUser etc), because most people don't read the docs. What methods do you use the most?
3. regarding this one - we don't see any real value here.