Skip to content

Latest commit

 

History

History
15 lines (8 loc) · 725 Bytes

README.md

File metadata and controls

15 lines (8 loc) · 725 Bytes

@arsonar/server

Sonar REST API server

Usage

node bin.js start starts the server. If installed globally, this is the same as sonar server start. The server listens on port 9191 by default, and only on localhost (not exposed publicly).

The server is only intended to be run on localhost, and not for being reachable over public networks. There's no authentication built in yet. We'll add token based authentication soon.

HTTP API documentation

Open https://localhost:9191/api-docs or browse the swagger file.

HTTP API docs are generated by swagger. Use npm run build:swagger to convert the swagger.yaml to JSON and commit both the yaml and the json.