Swagger API docs in SiYuan?

I tried to figure out the SiYuan API, but there is almost no useful documentation.
Is it planned to implement Swagger documentation in the application?

    Welcome to here!

    Here we can learn from each other how to use SiYuan, give feedback and suggestions, and build SiYuan together.

    Signup About
    Please input reply content ...
    • ACai

      I'm not a developer, but I think the implementation of swagger API docs can only be done with community help.

      Just like the API fox documentation I provided above, it also provides interaction examples for developers.

    • MiscReply
    • Vakula
      PRO Author

      Thanks, Swagger is almost the de facto standard for API documentation in software products (it automates and helps with reactive development).

      For example configuration file Swagger of my beloved Grist
      When I switch to myinstancegrist/apiconsole I get the most convenient documentation with a sandbox and interaction examples for developers.

    • ACai

      You can view a code example for each API and execute the corresponding API within your SiYuan workspace using the local SiYuan API URL and API token

    • ACai

      I'm not entirely sure of Swagger's exact purpose, but you can refer to the API documentation created by the community:

      介绍 - 思源笔记社区平台