General Direction on Getting Started

  • Resolved historicalwork

    (@historicalwork)


    4 years, 1 month ago

    Hi, i realize you may not be able to provide the needed direction. But from a past developer we have swagger docs setup for our API on a regular linux server elsewhere. I’d like to move them to a WordPress site and found your plugin. My skills are limited and I am not clear how I configure that using your plugin. I have it installed and I can view the default swagger page it creates at /rest-api/scheme. What I’m not sure about is how I configure it for the swagger docs I have elsewhere (i’ll get a copy of them). Is there a place I need to drop in the other files so it picks up our swagger docs? I tried to read through other topics and look at the code but I have to say I am unclear. Even some quick direction to point me in the right direction would be appreciated. Appreciate your help.

Viewing 3 replies - 1 through 3 (of 3 total)
  • Thread Starter historicalwork

    (@historicalwork)

    4 years, 1 month ago

    Btw, i apologize if I misunderstood the purpose of your plugin. Is it just to view in swagger format endpoints for plugins someone developed for WordPress? Meaning, it isn’t intended to show other API documentation? I came to this plugin because we use a WordPress portal for user support of our API and I wanted to somehow include the API documentation in the same place. If I just put the HTMP files in a directory the same server with WordPress then it is not within the wordpress authentication and I can’t easily password protect the API swagger docs like other WordPress pages.

    calcazar

    (@calcazar)

    4 years ago

    Hi @historicalwork !!!

    I was stuck in the same place you were. If you go to your word press settings, you’ll see a “swagger” option. If you go in there you can set the base path. The Base path is what this plugin uses to display the list of API’s.

    To answer your question, this plugin does indeed show your custom API’s. you have to make sure they are registered using the rest_api_init action.

    Let me know if you have any questions! I’m new to this too but I figured I’d share 🙂

    Plugin Author agussuroyo

    (@agussuroyo)

    3 years, 10 months ago

    Hi @calcazar and @historicalwork

    thanks for discussing about this,
    and for you information, this plugin purpose is used to display WordPress REST API into Swagger UI interface, so API that created internally for WordPress can be seen easily

    Sorry, this plugin is not used to display API docs outside of WordPress installation, currently this plugin is not supported and basically it’s not used for it

    Thanks

Viewing 3 replies - 1 through 3 (of 3 total)
  • The topic ‘General Direction on Getting Started’ is closed to new replies.