Skip to main content

7 posts tagged with "JSightOnlineEditor"

View All Tags

· One min read
Constantine Malyshev

This is an image

We have published the JSight Online Editor code on GitHub under the Apache 2.0 license. Our project was initially intended to be open-source, and we are already a step away from it. Along with the JSight Online Editor code, we also published several libraries and, most importantly, JSight language specifications.

If you’re a developer and willing to spend some time on JSight, welcome to our open-source team! Write to us here:

Also, if you enjoy JSight, star us on GitHub, this is very important for us.

· 4 min read
Constantine Malyshev

This is an image

We are pleased to announce that we have released the API sharing function in cloud with a unique link as part of JSight Online Editor release 4.0. This feature is a great addition to the ability to export documentation in a single HTML file. You may now choose whether to download the documentation as HTML or store it in the cloud using a unique URL.

Sharing documents via a link will provide you with three fantastic benefits:

  1. Quickly share and discuss an API description with a colleague.
  2. Store API documentation in the JSight cloud.
  3. View the entire history of document modifications. (You can always revert to any previous version of the API by simply decreasing the version number in the link. You can also easily find the most recent API version (more on that below).

Furthermore, there is no need to register anywhere to share via the link, and it is absolutely free.

How to use sharing effectively? There are a great many options, for example:

  1. You can quickly design an API on the fly in a team, exchanging links with drafts with each other.
  2. You can save all references to all your APIs in Confluence and always have access to the most recent versions of the documentation.
  3. You can send a link to the client so that they always have access to the latest version of the API.

See how it works by following the unique API example link: https://editor.jsight.io/r/g6X2ajV/3

Sharing API instructions

How to share documentation for the new API

Sharing is done as follows:

  1. Describe your API.
  2. Press the “Share” button (top right).
  3. In the window that appears, copy the unique link to this API.

This is an image

You can now share this link with anyone, and be sure that the content of the link will never change.

How to update a previously shared API

If you want to change the content of the link, then you need to create a new version of the API. It is done as follows:

  1. Open an existing API link.
  2. Make changes to the API description.
  3. Press the “Share” button (top right).
  4. Select “Update API” (under the “Share” button).
  5. In the window that opens, copy the new permanent link. The only difference between the new and original links is the last digit, which represents the serial number of the API version. For example, if your API was saved with the link https://editor.jsight.io/r/qjxZ46a/1, then when you update this API, the new link will be https://editor.jsight.io/r/aL9pnjZ/2 (the last digit has changed from 1 to 2 – this is the version number).

This is an image

This way you can create as many versions of your API as you want, and each will have its own unique link.

How to check the latest API version

If you don’t know which API version is the most recent, then you can open the link in your browser without specifying the version, that is, without the last digit. For example, instead of the link https://editor.jsight.io/r/qjxZ46a/2, open the link https://editor.jsight.io/r/qjxZ46a/ (I deleted the number 2 at the end), and the system will automatically redirect you to the latest saved version of your API.


P.S. We are currently working on creating convenient social snippets. This will allow you to immediately see the title and other important parameters of the sent API in the chat when sending a unique link.

· 2 min read
Constantine Malyshev

This is an image

We are happy to announce the release of a new version of JSight Online Editor 4.0..

The official release page is here.

Main feature of the release: You can now share API documentation via a unique link. All you need to do is click on the “Share” button and copy the link.

This is an image

We also thought about versioning the API documentation. It can be done like this:

  1. Open the API documentation via a unique link, for example, https://editor.jsight.io/r/NQBd0BA/1.
  2. Make changes to the API.
  3. Click on the “Share” button and select the option “Update API”.
  4. Your changes are saved with a new link which has a new version number. The new link completely matches the first link, except for the last digit - the version number, which is increased by one https://editor.jsight.io/r/NQBd0BA/2.

This is an image

Sharing documents via a link will provide you with three fantastic benefits:

  1. Quickly share and discuss an API description with a colleague.
  2. Store API documentation in the editor's cloud.
  3. View the entire history of document modifications. (You can always revert to any previous version of the API by simply decreasing the version number in the link).

Another major update in release 4.0 is improved JSight syntax highlighting. Now the editor accurately highlights all the syntax features of the JSight API language.

· 2 min read
Constantine Malyshev

This is an image

We plan to release a new version of JSight Online Editor by the end of May 2022. Among other minor improvements, there will be two new important features:

  1. Smart syntax highlighting, which will allow you to write code in JSight even faster.
  2. Sharing API documentation using a link.

Sharing documents via a link will provide our users with three fantastic benefits:

  1. Quickly share and discuss an API description with a colleague. You simply need to follow three steps: describe the API, copy the URL, and send the link to a colleague in a chat.
  2. Store API documentation in the editor's cloud. Do not forget to save a permanent link to the document in someplace safe.
  3. View the entire history of document modifications. The unique version number in the link itself updates whenever the API documentation changes. For example, if the URL to the first version of the API was https://editor.jsight.io/r/pPeJazR/1, the link to the following version would be https://editor.jsight.io/r/pPeJazR/2 (only the last digit changes). So you can always revert to any previous version of the API by simply decreasing the version number in the link.

Thank you for your attention! Along with you, we are also looking forward to the release and your feedback on the new features.

· 2 min read
Constantine Malyshev

This is an image

Hi everybody! We have a new release of JSight Online Editor 3.0! The official release page may be found here: JSight Online Editor 3.0 Release Notes.

There are two cool features in this version:

Firstly, “Preview” and “Export” buttons are added. By using these buttons, you can see the final API documentation design and, if you like it, download it in HTML format.

This is an image

Secondly, we have added macros support into the JSight language. And it's really very cool! JSight now looks like a true programming language (programmers will understand us). With the directive MACRO, you may now declare a macro, and with the directive PASTE, you may paste this macro anywhere in your API an unlimited number of times. Macros are useful, for instance, for quick attachment of standard responses to each resource in case of an error. As an example:

GET /cats

200 [@cat]
PASTE @commonErrors

GET /dogs

200 [@dog]
PASTE @commonErrors

MACRO @commonErrors
(
400 any
401 any
405 any
500 any
)

You can read more about the directives MACRO and PASTE in the JSight language specification:

We have also improved the UX in some places and fixed a few minor bugs.

We plan to release the next version of JSight Online Editor 4.0 by the end of May. The main innovation of this version will be the “Share” button. With this button, you will be able to save documentation in the cloud and share it with colleagues just by sending them a unique link to the document.

We also hope to add JSON-RPC support to the JSight language in the near future.

· 2 min read
Constantine Malyshev

This is an image

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:

  1. 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.
  2. 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!

· 2 min read
Constantine Malyshev

This is an image

Greetings everyone. Finally, we are pleased to announce the release of our first tool in the JSight ecosystem line: JSight Online Editor.

You can describe your REST API using our new JSight language in JSight Online Editor and get beautiful generated documentation directly in the browser.

Assess the simplicity and power of the JSight language, as well as the convenience of JSight Online Editor right now, without leaving the browser!

Training materials that may be useful to you:

We intend to release updates to the JSight Online Editor every two weeks starting today. We are planning to include the following features in the next release on February 22:

  1. Add a MACRO directive to the language, which will allow you to create macros and reuse code in a flexible manner.
  2. Export API documentation to HTML format.
  3. Improve JSight syntax highlighting.
  4. Make the Rules sidebar on the right more usable.
  5. Make other minor improvements.

We have already planned to publish the entire JSight Online Editor code on GitHub this month.

Dear users, your feedback is extremely important to us! Because the goal of our project is to create the most convenient tools especially for you, and no one else.

If

  • you don't understand something,
  • you found an error,
  • are you missing some functionality,
  • you come up with a great idea,
  • you want to become a part of our team,

then please write to us, we will be very happy:

Email: support@jsight.io
Telegram: @jsight_support