50 lines
1.2 KiB
Plaintext
50 lines
1.2 KiB
Plaintext
---
|
|
title: API
|
|
hide_title: true
|
|
sidebar_position: 9
|
|
---
|
|
|
|
import { Buffer } from "buffer";
|
|
global.Buffer = Buffer;
|
|
import SwaggerUI from "swagger-ui-react";
|
|
import openapi from "/resources/openapi.json";
|
|
import "swagger-ui-react/swagger-ui.css";
|
|
// import { Alert } from "antd";
|
|
|
|
## API
|
|
|
|
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).
|
|
|
|
<!--
|
|
TODO: (corbinrobb) Uncomment Alert if/when antd gets added and remove Infima alert. Fix SwaggerUI readability in dark mode.
|
|
-->
|
|
|
|
<!-- <Alert
|
|
type="info"
|
|
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)
|
|
</div>
|
|
|
|
}
|
|
/> -->
|
|
|
|
<div class="alert alert--info" role="alert">
|
|
<strong>NOTE! </strong>
|
|
You can find an interactive version of this documentation on your local Superset
|
|
instance at <strong>/swagger/v1</strong> (if enabled)
|
|
</div>
|
|
|
|
<br />
|
|
<br />
|
|
<hr />
|
|
<div className="swagger-container">
|
|
<SwaggerUI spec={openapi} />
|
|
</div>
|