[ 
https://issues.apache.org/jira/browse/HBASE-28977?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17898673#comment-17898673
 ] 

Dávid Paksy commented on HBASE-28977:
-------------------------------------

Here is the generated openapi JSON file which does not contain endpoint 
information, just the metadata:

 
{code:java}
{
  "openapi" : "3.0.1",
  "info" : {
    "title" : "Apache HBase REST API",
    "description" : "REST API server component of Apache HBase",
    "version" : "4.0.0-alpha-1-SNAPSHOT"
  },
  "servers" : [ {
    "url" : "/openapi"
  } ]
} {code}
This data was defined with {{io.swagger.v3.oas.annotations.OpenAPIDefinition}} 
annotation.

 

> Investigate integrating OpenAPI / Swagger to hbase-rest
> -------------------------------------------------------
>
>                 Key: HBASE-28977
>                 URL: https://issues.apache.org/jira/browse/HBASE-28977
>             Project: HBase
>          Issue Type: Improvement
>          Components: REST
>            Reporter: Dávid Paksy
>            Assignee: Dávid Paksy
>            Priority: Major
>
> Using OpenAPI / Swagger it would be possible to generate a schema file of 
> HBase REST API.
> In theory the generated schema file could be used as documentation / 
> generating API clients.
> Even Swagger UI could be used to have an interactive playground for the HBase 
> REST API.
> Check how much HBase could gain having this.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to