Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add implementation jsonapi-browser. #1611

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from

Conversation

masterT
Copy link

@masterT masterT commented Feb 16, 2022

@masterT masterT changed the title Add jsonapi-browser. Add implementation jsonapi-browser. Feb 16, 2022
@masterT
Copy link
Author

masterT commented Feb 18, 2022

Let's wait until it's more stable.

@jelhan
Copy link
Contributor

jelhan commented Feb 23, 2022

I played around with the tool a little bit. I think it has great potential. Do you have a list of features you are planning to add?

It seems that development has stopped on JSON:API Document Viewer. I'm wondering if we could maybe incorporate a visualization of the resources in a response in a similar way. I think a combination of a browser to navigate between resources together with a visualization of the resources would be very nice.

Maybe even a feature to create, update and delete resources could be added. An editor to create and modify a JSON:API document might be very helpful for teaching and testing as well.

@masterT
Copy link
Author

masterT commented Feb 23, 2022

Thanks for the feedback!

I don't have a clear plan for this project, but I have some ideas.

Add HTML representation for the JSON:API document fetched

Reference:

Maybe be able to see the JSON:API document as HTML similar to

Ex: Representing a JSON:API document with a resource as primary data:

Screen Shot 2022-02-23 at 10 57 23

Ex: Representing a JSON:API document with resource collection as primary data:

Screen Shot 2022-02-23 at 10 59 57

Support setting custom HTTP headers

Set custom HTTP headers (such as Authorization).


Maybe even a feature to create, update and delete resources could be added. An editor to create and modify a JSON:API document might be very helpful for teaching and testing as well.

I think it could be nice to edit and PATCH a fetched document using an HTML form. I might be possible because the "shape" of the document is already known.

For creating resources I think that without a proper specification of the resource it's not going to be easy to implement, nor pleasant for the user. The only solution I see is a form with a textarea to capture the JSON to send. 😬

That being said I'm working on creating a specification for API implementing JSON:API. The goal is to have a machine-readable specification of an API (something similar to RAML, swagger/OAS, API blueprint). With such a specification I could be possible to implement a tool to perform all the JSON:API operations. 🙂 My specification is at a very early stage, but if you want to sneak peek I created a gist.


I also have the idea to create an electron application to "bypass" the CORS, this way it could work on any API. This way it would be possible to set cookies (cross domain).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants