Added Swagger
This commit is contained in:
Binary file not shown.
|
After Width: | Height: | Size: 6.1 MiB |
@@ -0,0 +1,22 @@
|
||||
### `getEditorMetadata`
|
||||
|
||||
`getEditorMetadata` is a method that allows you to get information about the Editor's state without reaching directly into the plugin system.
|
||||
|
||||
Example:
|
||||
|
||||
```js
|
||||
const editor = SwaggerEditor({ /* your configuration here */ })
|
||||
|
||||
SwaggerEditor.getEditorMetadata()
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
```js
|
||||
{
|
||||
contentString: String,
|
||||
contentObject: Object,
|
||||
isValid: Boolean,
|
||||
errors: Array,
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,17 @@
|
||||
# Importing OpenAPI documents
|
||||
|
||||
Swagger Editor can import your OpenAPI document, which can be formatted as JSON or YAML.
|
||||
|
||||
### File → Import File
|
||||
|
||||
Click **Choose File** and select import. The file you are importing has to be a valid JSON or YAML OpenAPI document. Swagger Editor will prompt you about validation errors, if any exist.
|
||||
|
||||
### File → Import URL
|
||||
|
||||
Paste the URL to your OpenAPI document.
|
||||
|
||||
### Drag and Drop
|
||||
|
||||
Simply drag and drop your OpenAPI JSON or YAML document into the Swagger Editor browser window.
|
||||
|
||||

|
||||
Reference in New Issue
Block a user