Lesson 7. Project metadata

Example 7.1. Project metadata

JSIGHT 0.3
 
INFO
  Title "Cat's API."
  Version 0.1
  Description
    Welcome to the **Cat's API** markdown description.
 
    This API is described using JSight Language.
 
SERVER @prod // Real server.
  BaseUrl "https://cats.com/api"
 
SERVER @test // Test server.
  BaseUrl "https://test.cats.com/api"
 
GET /cats/{id} // Get a cat by its id.
  200
    {
      "id"  : 123,
      "name": "Tom"
    }

Open this example in the JSight Online Editor →

The given example describes the project's general metadata of using the directives INFO, Title, Version, Description, SERVER, BaseUrl. The example demonstrates the significance of these directives.

info

For more information about this topic, see:

• JSight API specification, chapter “DIRECTIVE "INFO"”.
• JSight API specification, chapter “DIRECTIVE "Title"”.
• JSight API specification, chapter “DIRECTIVE "Version"”.
• JSight API specification, chapter “DIRECTIVE "Description"”.
• JSight API specification, chapter “DIRECTIVE "SERVER"”.
• JSight API specification, chapter “DIRECTIVE "BaseUrl"”.