mirror of
https://github.com/apache/superset.git
synced 2026-05-22 00:05:15 +00:00
a591eccfc2
* docs: update lock file
* remove redundant npm lock file
* add missing peer deps
* fix TODO and bump antd
* fix API spec script
(cherry picked from commit 3313530f4d)
38 lines
855 B
Plaintext
38 lines
855 B
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).
|
|
|
|
<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> (unless disabled)
|
|
</div>
|
|
}
|
|
/>
|
|
|
|
<br />
|
|
<br />
|
|
<hr />
|
|
<div className="swagger-container">
|
|
<SwaggerUI spec={openapi} />
|
|
</div>
|