Orientação gerada a partir de informações públicas. Apenas para referência.
japx é um pacote leve para Flutter/Dart projetado para analisar e trabalhar com dados estruturados em JSON:API. Ele simplifica o processo de lidar com respostas de servidores que seguem a especificação JSON:API, permitindo que desenvolvedores extraiam e gerenciem recursos, relacionamentos e metadados de forma eficiente. O pacote é otimizado para desempenho e facilidade de uso, sendo ideal para aplicativos que integram backends compatíveis com JSON:API. Com baixo overhead, o japx suporta todas as principais plataformas, incluindo Android, iOS, Web, macOS, Windows e Linux.
Casos de uso
Analisando respostas JSON:API
Gerenciando relacionamentos aninhados
Extraindo metadados de cargas úteis da API
Construindo aplicativos com backends JSON:API
Simplificando a modelagem de dados da API
Principais recursos
Leve e rápido
Suporta a estrutura completa do JSON:API
Compatibilidade multiplataforma
Interface de análise fácil de usar
Boilerplate mínimo
Indicado para
Aplicativos Flutter usando JSON:API
Desenvolvedores que precisam de análise eficiente de API
Projetos que exigem transformação de dados limpos
Equipes trabalhando com APIs REST que seguem a especificação JSON:API
Aplicativos direcionados a múltiplas plataformas
Considerações
Requer o cumprimento do formato JSON:API
Limitado a casos de uso específicos do JSON:API
Nenhum cache interno ou camada de rede
Não adequado para estruturas de dados não JSON:API
Dependente da compatibilidade do JSON:API do lado do servidor
README original
Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.
Flutter Japx - JSON:API Decoder/Encoder
Lightweight [JSON:API][1] parser that flattens complex [JSON:API][1] structure and turns it into simple JSON and vice versa.
It works by transferring Map<String, dynamic> to Map<String, dynamic>, so you can use json_serializable or any other object mapping tool that you prefer.
For decoding the API responses use function Japx.decode(Map<String, dynamic> jsonApi, {String includeList}) which returns flattened JSON.
Include list is an optional parameter and it is used for deserializing JSON:API relationships.
For encoding use function Japx.encode(Object json, {Map<String, dynamic> additionalParams}) which will return a JSON with JSON:API format.
{"data":[{"type":"articles","id":"1","attributes":{"title":"JSON API paints my bikeshed!","body":"The shortest article. Ever.","created":"2015-05-22T14:56:29.000Z","updated":"2015-05-22T14:56:28.000Z"},"relationships":{"author":{"data":{"id":"42","type":"people"}}}}],"included":[{"type":"people","id":"42","attributes":{"name":"John","age":80,"gender":"male"}}]}
Parsed JSON:
{"data":[{"type":"articles","id":"1","title":"JSON API paints my bikeshed!","body":"The shortest article. Ever.","created":"2015-05-22T14:56:29.000Z","updated":"2015-05-22T14:56:28.000Z","author":{"type":"people","id":"42","name":"John","age":80,"gender":"male"}}]}
Decoding additional info
Response:
{"data":[{"type":"articles","id":"3","attributes":{"title":"JSON API paints my bikeshed!","body":"The shortest article. Ever.","created":"2015-05-22T14:56:29.000Z","updated":"2015-05-22T14:56:28.000Z"}}],"meta":{"total-pages":13},"links":{"self":"http://example.com/articles?page[number]=3&page[size]=1","first":"http://example.com/articles?page[number]=1&page[size]=1","prev":"http://example.com/articles?page[number]=2&page[size]=1","next":"http://example.com/articles?page[number]=4&page[size]=1","last":"http://example.com/articles?page[number]=13&page[size]=1"},"additional":{"info":"My custom info"}}
Parsed JSON:
{"data":[{"type":"articles","id":"3","title":"JSON API paints my bikeshed!","body":"The shortest article. Ever.","created":"2015-05-22T14:56:29.000Z","updated":"2015-05-22T14:56:28.000Z"}],"meta":{"total-pages":13},"links":{"self":"http://example.com/articles?page[number]=3&page[size]=1","first":"http://example.com/articles?page[number]=1&page[size]=1","prev":"http://example.com/articles?page[number]=2&page[size]=1","next":"http://example.com/articles?page[number]=4&page[size]=1","last":"http://example.com/articles?page[number]=13&page[size]=1"},"additional":{"info":"My custom info"}}
{"type":"articles","id":"1","title":"JSON API paints my bikeshed!","body":"The shortest article. Ever.","created":"2015-05-22T14:56:29.000Z","updated":"2015-05-22T14:56:28.000Z","author":{"type":"people","id":"42","name":"John","age":80,"gender":"male","article":{"type":"articles","id":"1","title":"JSON API paints my bikeshed!","body":"The shortest article. Ever.","created":"2015-05-22T14:56:29.000Z","updated":"2015-05-22T14:56:28.000Z","author":{"type":"people","id":"42","name":"John","age":80,"gender":"male"}}}}
Encode result:
{"data":{"type":"articles","id":"1","attributes":{"title":"JSON API paints my bikeshed!","body":"The shortest article. Ever.","created":"2015-05-22T14:56:29.000Z","updated":"2015-05-22T14:56:28.000Z"},"relationships":{"author":{"data":{"id":"42","type":"people"}}}}}
Simple project with mocked API can be found in this repository. Clone the repository, set the main.dart as an application starting point and run the project.
Usage with JsonSerializable
This package can be implemented as a simple layer into your exisiting stack. For example, if you use JsonSerializable, you can do it like this:
We believe that the community can help us improve and build better a product.
Please refer to our contributing guide to learn about the types of contributions we accept and the process for submitting them.
To ensure that our community remains respectful and professional, we defined a code of conduct that we expect all contributors to follow.
We appreciate your interest and look forward to your contributions.
License
Copyright 2024 Infinum
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.