State of this project

[NicolasCARPi]

Hello reader.

I started working on this project in 2020 simply because I used it, and original author stopped working on it (and was kind enough to give me write access). I spent quite some time reworking a lot of the code (like merging the core back into the repo, merging PR, fixing bugs and updating very outdated things).

When designing APIv2 for my app, I switched to OpenAPI specification, which is much better than documenting the API in source code comments like what apidoc does. It also allows me to generate client code directly from the spec without having to do anything.

My point is that nowadays I would recommend using OpenAPI spec to describe your endpoints, and then whatever doc engine you wish to use. But the important part is that now I do not use apidoc anymore.

Which means I don't have the incentive to maintain it for free, answer issues, fix bugs, etc...

I'm effectively stepping out of maintainer status for this project.

Now that you know that apidoc is not really maintained, it might be a good time to re-evaluate your choices regarding the tech stack for api documentation.

Best regards,
~Nicolas

[cotterjd]

This is sad to hear. apidoc is waaaaaay easier to use than OpenAPI imo, and more flexible too (Only issue I ever had with it was that trying out the route from the docs never worked, but I don't see this feature in the alternatives either)

[m5x5]

Hey @NicolasCARPi is there a way I can receive the maintainer role or somehow start contributing to the project? I noticed the project recently since Habitica uses it. I'd agree with @cotterjd it seems way easier compared to swagger.

I'm mostly interested in adding experience enhancements to the tool. Here is a pull request I opened that shows what I'm working on atm #1441

[NicolasCARPi]

@m5x5 you'll have to ask @rottmann .

[rottmann]

@NicolasCARPi
I would thank Nicolas for his work for some years on the project! 👍 (Sorry that i saw this Issue not earlier)

Unfortunately, I have to admit that I can't find time for this project. I've had the hope again and again for years. Unfortunately an illusion.

In the meantime the ecosystem around OpenAPI growth and it is defacto industry standard and included in many projects, especially in automatic api documentation.

APIDoc is (from writing the annotations) easier to use as OpenAPI, but the automatic tools of OpenAPI made them more powerful as APIDoc is today.

APIDoc is still used by many projects, but the zenith was reached in 2022:
https://npm-stat.com/charts.html?package=apidoc&from=2014-02-15&to=2024-02-15

@m5x5
I can give you access to the project, but currently i prefer to set this project to read only and refer to OpenAPI.

There are tools, that help to convert APIDoc to OpenAPI (Swagger), like: https://github.com/amanoooo/apidoc-swagger-3

[NicolasCARPi]

i prefer to set this project to read only and refer to OpenAPI.

Do what you will, but I don't see the harm in letting @m5x5 continue improving it, instead of completely archiving it (which has its benefits, too!). Maybe a clearer warning could be added in the README to inform that new projects should not use this.

I do very much agree that open api spec and tooling is vastly superior to apidoc's approach.

[noriellecruz]

It's sad to see Apidoc reaching its end of life. I think the best course we can take now is to help update this repo: https://github.com/amanoooo/apidoc-swagger-3 to support the latest Apidoc changes so current users can transition easily.

[bauerbach]

So sad to see this go unmaintained! I have done a lot of hard work documenting the API for my project, and now I have to completely redo the documentation from scratch. Thanks A LOT, Nicholas!

[satokenta940]

I'm sorry to see that no one is currently maintaining it. I have been using it before, thank you. Currently using Apidog, I believe it perfectly solves my anxiety.

[bauerbach]

I'm sorry to see that no one is currently maintaining it. I have been using it before, thank you. Currently using Apidog, I believe it perfectly solves my anxiety.

Apidog appears to be a commercial project that has a limited free plan. I want a documentation package that is completely free and as easy to use as this one was.

[cotterjd]

@m5x5 if you don't get maintainer, I'd encourage you to continue work on your fork (I gave it a star 😊) and let me know if you need help with it.