The goal of this project is to standardise the documentation of REST APIs at Språkbanken.
This repository contains:
Please check the guidelines document for more information on how to write documentation for Språkbanken's REST APIs.
By registering your Open API Specification (OAS) file in oas-register.yaml
an HTML version of the
documentation will automatically be available on the SB API documentation portal.
To register your API documentation please add the following information to oas-register.yaml
:
name
: The name of your API (used as meta data only).oas-file
: The URL from where the OAS file can be retrieved. This URL must be accessible from Språkbanken's servers.path
: The path to your API documentation that will be created automatically. This path should be relative to thepath
is set to sparv
the documentationdescription
: A very short description of the API.favicon
: Optional. A link to the API's favicon.To preview your API documentation, you can use the test page available at https://ws.spraakbanken.gu.se/docs/test.