Add /docs endpoint to retrieve OpenAPI documentation (#713)

sui/src/rest_server.rs

@@ -51,6 +51,9 @@ async fn main() -> Result<(), String> {
 
     let mut api = ApiDescription::new();
 
+    // [DOCS]
+    api.register(docs).unwrap();
+
     // [DEBUG]
     api.register(genesis).unwrap();
     api.register(sui_start).unwrap();
@@ -66,11 +69,12 @@ async fn main() -> Result<(), String> {
     api.register(call).unwrap();
     api.register(sync).unwrap();
 
-    api.openapi("Sui API", "0.1")
-        .write(&mut std::io::stdout())
+    let documentation = api
+        .openapi("Sui API", "0.1")
+        .json()
         .map_err(|e| e.to_string())?;
 
-    let api_context = ServerContext::new();
+    let api_context = ServerContext::new(documentation);
 
     let server = HttpServerStarter::new(&config_dropshot, api, api_context, &log)
         .map_err(|error| format!("failed to create server: {}", error))?
@@ -83,6 +87,7 @@ async fn main() -> Result<(), String> {
  * Server context (state shared by handler functions)
  */
 struct ServerContext {
+    documentation: serde_json::Value,
     genesis_config_path: String,
     wallet_config_path: String,
     network_config_path: String,
@@ -96,8 +101,9 @@ struct ServerContext {
 }
 
 impl ServerContext {
-    pub fn new() -> ServerContext {
+    pub fn new(documentation: serde_json::Value) -> ServerContext {
         ServerContext {
+            documentation,
             genesis_config_path: String::from("genesis.conf"),
             wallet_config_path: String::from("wallet.conf"),
             network_config_path: String::from("./network.conf"),
@@ -110,6 +116,35 @@ impl ServerContext {
     }
 }
 
+/**
+Response containing the API documentation.
+ */
+#[derive(Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
+struct DocumentationResponse {
+    /** A JSON object containing the OpenAPI definition for this API. */
+    documentation: serde_json::Value,
+}
+
+/**
+Generate OpenAPI documentation.
+ */
+#[endpoint {
+    method = GET,
+    path = "/docs",
+    tags = [ "docs" ],
+}]
+async fn docs(
+    rqctx: Arc<RequestContext<ServerContext>>,
+) -> Result<HttpResponseOk<DocumentationResponse>, HttpError> {
+    let server_context = rqctx.context();
+    let documentation = &server_context.documentation;
+
+    Ok(HttpResponseOk(DocumentationResponse {
+        documentation: documentation.clone(),
+    }))
+}
+
 /**
 Request containing the server configuration.