[GitHub] [incubator-superset] villebro commented on a change in pull request #11154: docs: add API page to docs using Swagger UI

[GitBox <gi...@apache.org>]

villebro commented on a change in pull request #11154:
URL: https://github.com/apache/incubator-superset/pull/11154#discussion_r499221584



##########
File path: docs/src/pages/docs/api.mdx
##########
@@ -0,0 +1,34 @@
+---
+name: API
+title: API
+route: /docs/api
+---
+## API
+
+import SwaggerUI from 'swagger-ui-react';
+import openapi from 'src/resources/openapi.json';
+import 'swagger-ui-react/swagger-ui.css';
+import { Alert } from 'antd';
+
+
+Superset's public **REST API** follows the
+[OpenAPI specification](https://swagger.io/specification/), and is
+documented here. The docs bellow are generated using
+[Swagger React UI](https://www.npmjs.com/package/swagger-ui-react).
+
+<Alert
+  message={
+    <div>
+      <strong>NOTE! </strong>
+      You can find an interactive version of this documentation
+      on your local Superset instance
+      at <strong>/swagger/v1</strong> (if enabled)

Review comment:
       nit: `FAB_API_SWAGGER_UI` is enabled by default:
   ```suggestion
         at <strong>/swagger/v1</strong>
   ```




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org