[
https://issues.apache.org/jira/browse/DRILL-8162?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17503017#comment-17503017
]
ASF GitHub Bot commented on DRILL-8162:
---------------------------------------
estherbuchwalter opened a new pull request #2489:
URL: https://github.com/apache/drill/pull/2489
# [DRILL-8162](https://issues.apache.org/jira/browse/DRILL-8162): Add
OpenAPI Specification documentation for Drill's REST API
## Description
Used Swagger Core to produce an OpenAPI specification for Drill's REST API.
One can access it in JSON format by going to `localhost:8047/openapi.json`
after starting Drill.
Also, added an HTML script to produce the Swagger UI when one visits
`localhost:8047/static/swagger-ui.html`.
Used Swagger annotations to populate the Swagger UI with the relevant
information, including links to documentation on
[https://drill.apache.org/docs/](https://drill.apache.org/docs/). More
information can be added via additional annotations.
## Documentation
One can visit `localhost:8047/openapi.json` after starting Drill to find an
OpenAPI specification for Drill's REST API. One can also visit
`localhost:8047/static/swagger-ui.html` after starting Drill to find the
Swagger UI, which clearly displays the endpoints for the REST API with their
descriptions and/or links to external docs.
## Testing
Started Drill and visited the links above.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
> Add OpenAPI Specification documentation for Drill's REST API
> ------------------------------------------------------------
>
> Key: DRILL-8162
> URL: https://issues.apache.org/jira/browse/DRILL-8162
> Project: Apache Drill
> Issue Type: Improvement
> Components: Documentation
> Reporter: Esther Buchwalter
> Priority: Minor
>
> Used Swagger Core to produce an OpenAPI specification for Drill's REST API.
> Added an HTML script to produce the Swagger UI when you visit:
> {code:java}
> hostname:8047/static/swagger-ui.html{code}
> Used Swagger annotations to populate the Swagger UI with the relevant
> information.
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
