Editing
JSON API Development
(section)
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
=== JSON API Basics === JSON API follows a set of conventions for structuring API endpoints, response payloads, and error handling. The key principles of JSON API are as follows: * **Resource-Oriented**: JSON API treats resources as the fundamental building blocks. Each resource is identified by a unique URL, and the API exposes various operations (e.g., create, read, update, delete) on these resources. * **Uniform Interface**: JSON API defines a consistent set of conventions for working with resources, including standard URLs, request/response formats, and error handling. This uniformity simplifies client-server interactions and enhances interoperability between different systems. * **JSON Payloads**: JSON API primarily uses JSON as the data format for request payloads and response bodies. This makes it easy to work with in Elixir, which has excellent support for JSON encoding/decoding. * **Relationships**: JSON API allows expressing relationships between resources. For example, a blog post resource may contain relationships with author and comments resources. These relationships provide a way to navigate and fetch related data efficiently.
Summary:
Please note that all contributions to Elixir Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
Elixir Wiki:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Page
Discussion
English
Views
Read
Edit
View history
More
Navigation
Main page
Recent changes
Random page
Help about MediaWiki
Tools
What links here
Related changes
Special pages
Page information