JSight API

05/24/2024

OpenAPI converter has been launched

We are pleased to announce that we have released the JSight → OpenAPI converter feature both in JSight Online Editor release 6.0 - https://jsight.io/products/jsight-online-editor/release-notes/ -60 and JSight CLI release 1.1.0 - https://jsight.io/products/cli/release-notes -110. Now JSight can be seamlessly integrated with the OpenAPI technology stack.

OpenAPI converter in JSight Online Editor

JSight Online Editor - https://editor.jsight.io/ now has an OpenAPI tab. When you describe your API with JSight, the OpenAPI code is instantly generated in the OpenAPI tab.
See the introductory video on using OpenAPI in JSight Online Editor - https://editor.jsight.io/:
https://youtu.be/AHGmibSdZlI

OpenAPI converter in JSight CLI

You can also now convert JSight descriptions into OpenAPI files using JSight CLI - https://jsight.io/products/cli . It is as simple as that:

jsight convert openapi yaml "my-api-spec.jst" > "my-api-spec.openapi"

Link to the example in the video: https://editor.jsight.io/r/YjPR862/1Please give us a star on GitHub! https://github.com/jsightapi/online-editor-frontendJSi...

05/21/2024

JSight CLI Release 1.1.0

Today, we are releasing JSight CLI 1.1.0 - https://jsight.io/products/cli/. It helps you to work with the JSight API language in a user console. The main feature of the current release is the ability to convert JSight API descriptions to OpenAPI definitions.

Syntax error messages have also been greatly improved: they are more detailed, accurate and include links to the documentation.

More details on the product: JSight CLI - https://jsight.io/products/cli.

The official release page can be found here: JSight CLI 1.1.0 Release Notes - https://jsight.io/products/cli/release-notes -110.

05/17/2024

JSight Online Editor Release 6.0

Today we release a new version of JSight Online Editor 6.0 - https://editor.jsight.io/

The official release page is here - https://jsight.io/docs/products/jsight-online-editor/release-notes/ -60

From now on, JSight supports OpenAPI 3.0. Now you can design your APIs in the JSight language and instantly convert them to the OpenAPI format.

We also fixed some minor bugs, improved usability, and made the syntax error messages more accurate.

08/16/2023

JSight CLI Release 1.0.0

Today, we are releasing JSight CLI 1.0.0 - https://jsight.io/products/cli/. It helps you to work with JSight API language in a user console.

The current release has the following features:

- Parsing of JSight API - https://jsight.io/docs/jsight-api-0-3 files.
- Checking JSight API - https://jsight.io/docs/jsight-api-0-3 syntax (with detailed messages in case of errors).
- Generating one-file HTML API doc (example - https://jsight.io/downloads/jsight-cli/api-doc-example.html).

More details about the product: JSight CLI - https://jsight.io/products/cli.

The official release page may be found here: JSight CLI 1.0.0 Release Notes - https://jsight.io/products/cli/release-notes -100.

08/11/2023

JSight VS Code Extension Release 1.0.0

Today, we are releasing JSight VS Code Extension 1.0.0 - https://marketplace.visualstudio.com/items?itemName=jsight.jsight. It helps you edit the JSight API specification in your favourite IDE.

VS Code Marketplace link: https://marketplace.visualstudio.com/items?itemName=jsight.jsight.

More details about the product: JSight VS Code Extension - https://jsight.io/products/ide-plugins/vs-code.

The official release page may be found here: JSight VS Code Extension 1.0.0 Release Notes - https://jsight.io/products/ide-plugins/vs-code/release-notes -100.

08/08/2023

JSight Validator Java Release 1.0.0

Today we are releasing JSight Java Validator 1.0.0 - https://jsight.io/products/jsight-validator/manuals/java.

This is a library, which validates all your API requests and responses against your API specification, written with JSight API language - https://jsight.io/docs/jsight-api-0-3-quick-tutorial.

More details about the product: JSight Validator - https://jsight.io/products/jsight-validator.

The official release page may be found here: JSight Validator Java Adapter 1.0.0 Release Notes - https://jsight.io/products/jsight-validator/release-notes/java-adapter -100.

06/22/2023

JSight story on Medium.com

What’s Wrong With OpenAPI?
How we struggled with API documentation on our projects and went a bit crazy...



gitconnected

How we struggled with API documentation on our projects and went a bit crazy

05/18/2023

JSight Validator PHP Release 1.0.1

Today, we are releasing a new version of JSight Validator PHP Extension 1.0.1 - https://jsight.io/products/jsight-validator/manuals/php.

This is a PHP extension, which validates all your API requests and responses against your API specification, written with JSight API - https://jsight.io/docs/jsight-api-0-3-quick-tutorial language.

More details about the product: JSight Validator - https://jsight.io/products/jsight-validator.

The official release page may be found here: JSight Validator PHP Extension 1.0.1 Release Notes - https://jsight.io/products/jsight-validator/release-notes/php-extension -101.

01/25/2023

JSight Validator Release 1.0

Today, we are releasing a new product: JSight Validator - https://jsight.io/products/jsight-validator.

This is a library that is designed to validate all incoming and outgoing API messages for compliance with the API specification written in the JSight API language - https://jsight.io/docs/jsight-api-0-3-quick-tutorial.

It works as follows:

1. Describe your API in JSight API language - https://jsight.io/docs/jsight-api-0-3-quick-tutorial and store the resulting API specification in the Git repository of your service.
2. Integrate JSight Validator into your service code (see instruction - https://jsight.io/products/jsight-validator).

Now all API calls will be validated by the JSight Validator against the API specification! This will provide you with the following benefits:

1. You can always be certain that the implementation of the API is 100% compliant with the specification.
2. You can trust the API specification as it accurately reflects the real API.
3. You don't have to write the validation code of input messages.
4. You don't have to write automated tests to check how the API responds to faulty messages.

For example, in PHP, HTTP request validation might look like this:

$error = jsight_validate_http_request(`my-api-spec.jst`, $method, $uri, $headers, $body);

if( $error ) return jsight_serialize_error('json', $error);

More details about the product: JSight Validator - https://jsight.io/products/jsight-validator.

10/24/2022

JSight Online Editor Release 5.0

We are very excited to announce the release of a new version of JSight Online Editor 5.0 - https://editor.jsight.io/.

The official release page is here - https://jsight.io/docs/products/jsight-online-editor/release-notes/ -50.

From now on, JSight supports the JSON-RPC 2.0 protocol - https://jsight.io/docs/jsight-api-0-3-quick-tutorial/lesson10. Now you can design and document your JSON-RPC APIs with the same ease as general REST APIs.

In addition, we fixed a few minor bugs and improved the usability.

You can read more about working with the JSON-RPC protocol here - https://jsight.io/docs/jsight-api-0-3-quick-tutorial/lesson10.

08/30/2022

JSight Online Editor has been published on GitHub

We have published the JSight Online Editor code on GitHub - https://github.com/jsightapi/online-editor-frontend 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 - https://github.com/jsightapi and, most importantly, JSight language specifications - https://github.com/jsightapi/specification.

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

Email: [email protected]
Telegram:

Also, if you enjoy JSight, star us on GitHub - https://github.com/jsightapi/online-editor-frontend, this is very important for us.

08/20/2022

The function of sharing API via a unique URL has been launched

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 – https://jsight.io/docs/products/jsight-online-editor/release-notes/ -40. 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.

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 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.