Automatic Specification Generator for Jenkins REST API

[kinlane]

Project goal: Find and implement the extraction of the REST APIs from the sources and generate and publish the REST APIs respective documentation

URL: https://www.jenkins.io/projects/gsoc/2020/project-ideas/automatic-spec-generator-for-jenkins-rest-api/#automatic-specification-generator-for-jenkins-rest-api

Background Developers need to know what to expect in terms of responses for each REST API endpoint, so external tools like jenkins-rest can be developed with confidence, and possibly with the help of some REST specification automation. For example, this could be done using the OpenAPI Specification (formerly known as Swagger Specification). Users of the REST API most often want:

HTTP responses and codes

Body of message and its format (e.g. JSON, html, etc.)

Jenkins does not have automated REST API documentation at all at this time. A lot of APIs are contributed from extensions, so there are multiple REST APIs (core and plugins) of varying versions. The goal of this project is to find and implement the extraction of the REST APIs from the sources and generate and publish the REST APIs respective documentation.