Skip to content

Commit

Permalink
Release 6.0
Browse files Browse the repository at this point in the history
Release 6.0
  • Loading branch information
andrew-platonov authored May 15, 2024
2 parents 2173659 + 2d56500 commit 2a843fa
Show file tree
Hide file tree
Showing 82 changed files with 3,796 additions and 2,745 deletions.
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
REACT_APP_API_URL=http://localhost:8080
REACT_APP_API_URL=https://dev.editor.jsight.io/api
REACT_APP_CLOUD_URL=https://cloud.jsight.io
REACT_APP_GTM_ID=
REACT_APP_CUSTOM_MESSAGE_URL=https://jsightapi.github.io/online-editor-custom-messages.json
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,4 @@ yarn-error.log*
.vscode

/local
.tool-versions
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# stage1 as builder
FROM node:14-alpine as builder
ARG API_URL="/parse-jsight"
ARG API_URL="/api"
ARG GTM_ID=""
ARG CLOUD_URL="https://cloud.jsight.io"
ARG CUSTOM_MESSAGE_URL="https://jsightapi.github.io/online-editor-custom-messages.json"
Expand Down
64 changes: 44 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,20 @@
</div>
</div>

**JSight Online Editor**you've never designed API so fast. We really mean it.
**JSight Online Editor**the most human-friendly language for designing APIs.

1. Write 2-4 times less code.
2. Design API 2-3 times faster.
3. Download beautiful HTML docs :book: or share API specifications in the cloud [:cloud:](https://editor.jsight.io).
4. Do not distract from the API design because of the API description process.
5. Design API together, it is extremely convenient with JSight language.
You've never designed API so fast. We really mean it.

1. OpenAPI is automatically generated.
2. Write 2-4 times less code.
3. Design API 2-3 times faster.
4. Download beautiful HTML docs :book: or share API specifications in the cloud [:cloud:](https://editor.jsight.io).
5. Do not distract from the API design because of the API description process.
6. Design API together, it is extremely convenient with JSight language.
No more multiple design iterations and edits required. All you need is to share the screen between
the participants and come up with an API together right in the Editor. All this is possible thanks
to the compactness and simplicity of the JSight language.
[Compare JSight with Open API](#scroll--jsight-api-language).
[Compare JSight with OpenAPI](#scroll--jsight-api-language).

Supported standards: [HTTP REST](#scroll--jsight-api-language), [JSON-RPC
2.0](#json-rpc-20-new-feature).
Expand All @@ -60,7 +63,7 @@ Supported standards: [HTTP REST](#scroll--jsight-api-language), [JSON-RPC
<img src="https://avatars.githubusercontent.com/u/101567029?v=4" align="left" width="40"
height="40" alt=""/>

Constantine M., JSight CRDO.
Konstantin M., JSight CRDO.

&nbsp;

Expand Down Expand Up @@ -95,7 +98,7 @@ Supported standards: [HTTP REST](#scroll--jsight-api-language), [JSON-RPC

&nbsp;

![Demo](./img/demo.gif)
![Demo](./img/openapi.gif)

<div>
&nbsp;
Expand Down Expand Up @@ -130,9 +133,10 @@ Supported standards: [HTTP REST](#scroll--jsight-api-language), [JSON-RPC

JSight Online Editor officially supports the latest browsers:

- Chrome 102.0,
- Firefox 101.0,
- Safari 15.3.
- Chrome 124.0,
- Firefox 125.0,
- Safari 17.3,
- Edge 124.0.

### Installing

Expand Down Expand Up @@ -194,10 +198,18 @@ Start JSight Server (on port 8080):
</td>
<td>

Linux:

```
SERVER_HOST_PORT=8080 docker-compose -f jsight-server-docker-compose.yml up -d
```

Windows PowerShell:

```
$env:SERVER_HOST_PORT=8080; docker-compose -f jsight-server-docker-compose.yml up -d --build
```

</td>
</tr>
<tr>
Expand Down Expand Up @@ -371,10 +383,18 @@ Build and start JSight Online Editor:
</td>
<td>

Linux:

```
FE_HOST_PORT=80 SERVER_HOST_PORT=8080 docker-compose -f docker-compose.yml up -d --build
```

Windows PowerShell:

```
$env:FE_HOST_PORT=80; $env:SERVER_HOST_PORT=8080; docker-compose -f docker-compose.yml up -d --build
```

</td>
</tr>
<tr>
Expand Down Expand Up @@ -1461,7 +1481,7 @@ TYPE @pet // A pet.
TYPE @cat // A cat.
{ // {allOf: "@pet"}
"status": "relaxing",
"bestFriend": @cat,
"bestFriend": @cat, // {optional: true}
"topFriends": { // {additionalProperties: true}
@petName: @cat | @pig
},
Expand Down Expand Up @@ -1704,9 +1724,10 @@ support](https://jsight.io/docs/jsight-api-0-3-quick-tutorial/lesson10).

## :book: &nbsp; Features

- Description of your REST API in a very simple and intuitive [JSight API language](https://jsight.io/docs/jsight-api-0-3).
- Description of your REST and JSON RPC API in a very simple and intuitive [JSight API language](https://jsight.io/docs/jsight-api-0-3).
- Instant automatic OpenAPI definition generation.
- Convenient syntax highlighting.
- Instant automatic document generation.
- Instant automatic HTML document generation.
- Intuitive document navigation.
- View data schemas in two formats: in the form of an example (Code View) and in a tabular form (Table View).
- Expand nested data types on click.
Expand All @@ -1722,7 +1743,7 @@ support](https://jsight.io/docs/jsight-api-0-3-quick-tutorial/lesson10).

- Download document also in MarkDown, PDF, and DOCX formats.
- Quick Help built into the editor allows you to quickly access the necessary information on the JSight API language without leaving the editor.
- Converting the JSight specification to OpenAPI and vice versa.
- Converting the OpenAPI specification to JSight.
- Automatic generation of API clients and API server stubs.
- Support for other types of API: gRPC, Kafka, RabbitMQ, WebSocket.
- Sending test requests to the API.
Expand Down Expand Up @@ -1883,16 +1904,17 @@ Links to the components:
- JSight Server API specification:
https://github.com/jsightapi/jsight-server/blob/main/jsight/jsight-server-api.jst.
- JSight Server repo: https://github.com/jsightapi/jsight-server.
- JSight API Go Library repo: https://github.com/jsightapi/jsight-api-go-library.
- JSight Schema Go Library repo: https://github.com/jsightapi/jsight-schema-go-library.
- JSight API Go Library repo: https://github.com/jsightapi/jsight-api-core.
- JSight Schema Go Library repo: https://github.com/jsightapi/jsight-schema-core.

<div>
&nbsp;
</div>

## :test_tube: &nbsp; Testing

The manual tests are available here: [tests/manual-tests/](./tests/manual-tests/).
- The **manual tests** are available here: [tests/manual-tests/](./tests/manual-tests/).
- The **automated tests** can be run via dedicated CI/CD pipelines. See more info about [running automated tests here](./tests/running-automated-tests-ci.md).

<div>
&nbsp;
Expand Down Expand Up @@ -1921,6 +1943,8 @@ document.
<a href="https://github.com/Anton-NS"><img src="https://avatars.githubusercontent.com/u/100565250?v=4" width="100" height="100" alt=""/></a>
<a href="https://github.com/Ekaterinacamposkuydina"><img src="https://avatars.githubusercontent.com/u/104357292?v=4" width="100" height="100" alt=""/></a>
<a href="https://github.com/bereg2k"><img src="https://avatars.githubusercontent.com/u/42677987?v=4" width="100" height="100" alt=""/></a>
<a href="https://github.com/tobiashochguertel"><img src="https://avatars.githubusercontent.com/u/3332669?v=4" width="100" height="100" alt=""/></a>
<a href="https://github.com/chepil"><img src="https://avatars.githubusercontent.com/u/1425370?v=4" width="100" height="100" alt=""/></a>

<div>
&nbsp;
Expand Down Expand Up @@ -1984,7 +2008,7 @@ details.

- All JSight repositories: https://github.com/jsightapi.
- GitHub discussions: https://github.com/jsightapi/online-editor-frontend/discussions.
- JSight video lessons:
- JSight Youtube:
https://www.youtube.com/watch?v=AegCETY9Cdk&list=PLy9sOecVhlybvRoDhGlzyMwKVxR-gFkdX

<div>
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ services:
- '${FE_HOST_PORT}:80'

jsight-server:
image: jsight/jsight-server:4
image: jsight/jsight-server:6.0
environment:
- JSIGHT_SERVER_CORS=true
- JSIGHT_SERVER_STATISTICS
Expand Down
Binary file added img/openapi.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion jsight-server-docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: '3.8'
services:
jsight-server:
image: jsight/jsight-server:4
image: jsight/jsight-server:6.0
environment:
- JSIGHT_SERVER_CORS=true
- JSIGHT_SERVER_STATISTICS
Expand Down
Loading

0 comments on commit 2a843fa

Please sign in to comment.