Skip to content

ONLYOFFICE/api.onlyoffice.com

This branch is 12 commits ahead of master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

92170a0 · Feb 19, 2025
Feb 19, 2025
Feb 10, 2025
Feb 11, 2025
Feb 14, 2025
Feb 19, 2025
Feb 19, 2025
Feb 10, 2025
Feb 14, 2025
Feb 19, 2025
Feb 5, 2025
Feb 14, 2025
Feb 19, 2025
Feb 8, 2025
Feb 19, 2025
Feb 10, 2025
Jan 29, 2025

Repository files navigation

API ONLYOFFICE Site

The API ONLYOFFICE site is the place for documentation on how to use ONLYOFFICE.

Contributing Documentation Updates

The documentation content is formatted in markdown and can be found in the site directory. Easiest way to make edits is to navigate to the markdown file to be updated, and click the Edit button in the top right (the pencil icon). After making the edit, submitting the changes will create a Pull Request (PR) for reviewed. Please feel free to ask any questions within the our forum, we're happy to help.

Building the Site

To build the site from the source, ensure you're using the most recent versions of Node and Npm, and pull the latest from master. Next, run npm install, npm run build to build the docs files and npm start to launch the site in development mode.

Generating OpenAPI Docs

Merging OenAPI Docs for docspace backend

To generate OpenAPI docs for docspace backend, you need to prepare a single file:

cd openapi/docspace
npm i
npx openapi-merge-cli

Generating All files

To generate all OpenAPI docs, run the following command from the root directory of your project:

yarn docusaurus gen-api-docs all

This will generate API docs for all of the OpenAPI specification (OAS) files referenced in your docusaurus-plugin-openapi-docs config.

Generating a single file

You may also generate OpenAPI docs for a single path or OAS by specifying the unique id:

yarn docusaurus gen-api-docs <id>

Example:

yarn docusaurus gen-api-docs docspaceBackend

The example above will only generate API docs relative to docspaceBackend.

Cleaning OpenAPI Docs

Cleaning All files

To clean/remove all API Docs, run the following command from the root directory of your project:

yarn docusaurus clean-api-docs all

Cleaning a single file

You may also remove a particular set of API docs by specifying the unique id of your desired spec instance.

yarn docusaurus clean-api-docs <id>

Example:

yarn docusaurus clean-api-docs docspaceBackend

The example above will remove all API docs relative to docspaceBackend.

Related

License