Many of you have requested that API documentation be shared in the JSight Online Editor via a unique URL. That was already in our plans, but considering your request, we decided to address this task earlier. The backend is complete, as well as the requirements specification for the frontend. Right now, we are creating its design. We plan to complete this feature by the end of April 2022.
We considered various UI options, and finally we liked the sharing option made by the guys at https://regex101.com/ (a service for working with regex).
The advantages of this solution:
- All URLs are permanent. The contents of a unique link never change. This saves us from having to deal with a lot of complexity in the user interface.
- If you need to change the code in the URL, you can simply create a new version of that URL. For example, you received a link https://editor.jsight.io/r/pPeJazR/1. Once you make edits into the code and save the new version, the new URL turns into https://editor.jsight.io/r/pPeJazR/2 (note that the version number at the end of the link is changed). The following version will include the number 3: https://editor.jsight.io/r/pPeJazR/3 , and so on.
This method is very convenient. Just by looking at the URL, you will understand the version number of your API, and you can always check what was in previous versions just by decrementing the URL version number.
Enjoy JSight Online Editor and share your ideas with us. Your feedback is important to us!