Join
6
6 Comments

Need Help - Best way to document and API?

by Nuno Bispo

Hello,

I have been working on a new kind of 2FA API that is meant to be simple, and easy to use for both developers and especially final users.

I have the beta release coded and read to go into the wild, at the moment finishing up the documentation and landing page.

I ask for your help on what is the best tool to document APIs that is easy to also maintain?

Nuno Bispo's avatarNuno Bispo
on December 17, 2021
Say something nice to nunobispo…
Post Comment
  1. 3

    OpenAPI is the de-facto standard way to describe an API. Then use Swagger UI or ReDoc or RapiDoc to present this to your users. Swagger UI is the most popular but the other two look much nicer.

    Irrummi's avatar Irrummi
    ·
    5 years ago
    ·
    Reply
    1. 1

      Thanks for the suggestion. I ended up going with readme.io.

      Feel free to take a look: https://securify.readme.io/

      Nuno Bispo's avatar Nuno Bispo
      ·
      5 years ago
      ·
      Reply
  2. 2

    https://swagger.io/docs/

    gator70's avatar gator70
    ·
    5 years ago
    ·
    Reply
    1. 1

      I will take a look also, thanks for sharing.

      Nuno Bispo's avatar Nuno Bispo
      ·
      5 years ago
      ·
      Reply
  3. 2

    Readme.io

    orliesaurus's avatar orliesaurus
    ·
    5 years ago
    ·
    Reply
    1. 1

      Looks very interesting, thanks for sharing.

      Nuno Bispo's avatar Nuno Bispo
      ·
      5 years ago
      ·
      Reply