Skip to main content

3 posts tagged with "JSightRelease"

View All Tags

· 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

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

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