Compare commits

...

6 Commits

Author SHA1 Message Date
7a7503be6a [macos] Fixed run example (#94) 2020-11-09 13:05:06 +03:00
1184402f94 fix table 2020-10-01 11:37:15 +03:00
5c0d8b8dd9 Merge branch 'release/v6.0.0' into develop
# Conflicts:
#	Readme.md
#	web/documentserver-example/nodejs/licenses/urllib.license
2020-09-30 19:12:05 +03:00
cadeb19ece Merge branch 'master' into release/v6.0.0
# Conflicts:
#	LICENSE.txt
2020-09-30 18:58:24 +03:00
fb039100e1 Update Readme.md 2020-07-23 18:51:17 +03:00
4a6b549eaa Update Readme.md (#80)
* Update Readme.md

- add API methods for text examples
2020-07-23 18:37:46 +03:00
2 changed files with 29 additions and 1 deletions

View File

@ -12,6 +12,34 @@ You should change `http://documentserver` to your server address in these files:
More information on how to use these examples can be found here: [http://api.onlyoffice.com/editors/demopreview](http://api.onlyoffice.com/editors/demopreview "http://api.onlyoffice.com/editors/demopreview")
## API methods for test examples
The methods described below are available for all of the test examples.
### POST `/upload`
| | |
| ---------------------- | ------------------------------------------------------------ |
| **Summary** | Upload file to test example via request |
| **URL** | /upload |
| **Method** | POST |
| **Request<br>Headers** | `Content-Type: multipart/form-data` |
| **Request<br>Body** | `uploadedFile=@<filepath>`<br> `filepath` - file for uploading<br />Multipart body with the file binary contents |
| **Response** | **Code:** 200 OK <br />**Content on success:**<br /> `{ "filename": <filename>}`<br />**Content on error:**<br /> `{ "error": "Uploaded file not found"}` <br /> Or <br /> `{ "error": "File size is incorrect"}` |
| **Sample** | `curl -X POST -F uploadedFile=@filename.docx http://localhost/upload` |
### DELETE `/file`
| | |
| ------------------ | ------------------------------------------------------------ |
| **Summary** | Delete one file or all files |
| **URL** | /file |
| **Method** | DELETE |
| ****URL Params**** | **Optional:**<br /> `filename=[string]` - file for deleting. <br /> *WARNING! Without this parameter, all files will be deleted* |
| **Response** | **Code:** 200 OK <br /> **Success:**<br /> `{"success":true}` |
| **Sample** | **Delete one file:**<br />`curl -X DELETE http://localhost/file?filename=filename.docx`<br />**Delete all files:**<br />`curl -X DELETE http://localhost/file`<br /> |
## Project Information
Official website: [https://www.onlyoffice.com](https://www.onlyoffice.com/?utm_source=github&utm_medium=cpc&utm_campaign=GitHubIntegrationEx)

View File

@ -1,7 +1,7 @@
{
"server": {
"port": 3000,
"siteUrl": "http://127.0.0.1:8080/",
"siteUrl": "http://127.0.0.1:8001/",
"apiUrl": "web-apps/apps/api/documents/api.js",
"preloaderUrl": "web-apps/apps/api/documents/cache-scripts.html"
}