Skip to main content

19 posts tagged with "apidoc"

View All Tags

· One min read
Konstantin Malyshev

This is an image

We are pleased to announce that we have released the JSight → OpenAPI converter feature both in JSight Online Editor release 6.0 and JSight CLI release 1.1.0. Now JSight can be seamlessly integrated with the OpenAPI technology stack.

OpenAPI converter in JSight Online Editor

JSight Online Editor 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:

OpenAPI converter in JSight CLI

You can also now convert JSight descriptions into OpenAPI files using JSight CLI. It is as simple as that:

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

· One min read
Konstantin Malyshev

This is an image

Today, we are releasing JSight CLI 1.1.0. 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.

The official release page can be found here: JSight CLI 1.1.0 Release Notes.

· One min read
Konstantin Malyshev

This is an image

Today we release a new version of JSight Online Editor 6.0.

The official release page is here.

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.

This is an image

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

· One min read
Konstantin Malyshev

This is an image

Today, we are releasing JSight CLI 1.0.0. It helps you to work with JSight API language in a user console. The current release has the following features:

  • Parsing of JSight API files.
  • Checking JSight API syntax (with detailed messages in case of errors).
  • Generating one-file HTML API doc (example).

More details about the product: JSight CLI.

The official release page may be found here: JSight CLI 1.0.0 Release Notes.

· One min read
Konstantin Malyshev

This is an image

Today, we are releasing JSight VS Code Extension 1.0.0. 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.

The official release page may be found here: JSight VS Code Extension 1.0.0 Release Notes.

· One min read
Konstantin Malyshev

This is an image

Today we are releasing JSight Java Validator 1.0.0.

This is a library, which validates all your API requests and responses against your API specification, written with JSight API language.

More details about the product: JSight Validator.

The official release page may be found here: JSight Validator Java Adapter 1.0.0 Release Notes.

· One min read
Konstantin Malyshev

This is an image

Today, we are releasing a new version of JSight Validator PHP Extension 1.0.1.

This is a PHP extension, which validates all your API requests and responses against your API specification, written with JSight API language.

More details about the product: JSight Validator.

The official release page may be found here: JSight Validator PHP Extension 1.0.1 Release Notes.

· 2 min read
Konstantin Malyshev

This is an image

Today, we are releasing a new product: 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.

It works as follows:

  1. Describe your API in JSight API language and store the resulting API specification in the Git repository of your service.
  2. Integrate JSight Validator into your service code (see manual).

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

  • You can always be certain that the implementation of the API is 100% compliant with the specification.
  • You can trust the API specification as it accurately reflects the real API.
  • You don't have to write the validation code of input messages.
  • 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.

· One min read
Konstantin Malyshev

This is an image

We are very excited to announce the release of a new version of JSight Online Editor 5.0.

The official release page is here.

From now on, JSight supports the JSON-RPC 2.0 protocol. Now you can design and document your JSON-RPC APIs with the same ease as general REST APIs.

This is an image

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

You can read more about working with the JSON-RPC protocol here.

· One min read
Konstantin 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.