Creating API documentation from php files?

This page summarizes the projects mentioned and recommended in the original post on reddit.com/r/PHP

Our great sponsors
  • SonarLint - Deliver Cleaner and Safer Code - Right in Your IDE of Choice!
  • Scout APM - Less time debugging, more time building
  • SaaSHub - Software Alternatives and Reviews
  • swagger-php

    A php swagger annotation and parsing library

    Ah right, so you're building a (presumably REST) API and you want to generate docs for the endpoints from your code. Slightly different scenario to what I assumed. There are a couple of libraries to generate OpenAPI specs from source files, I think this is the main one https://github.com/zircote/swagger-php though FWIW I prefer to maintain my API specs separately from the code and use those to guide what I'm building, rather than 'tother way round.

  • apiDoc

    RESTful web API Documentation Generator.

    This one works well: https://github.com/apidoc/apidoc

  • SonarLint

    Deliver Cleaner and Safer Code - Right in Your IDE of Choice!. SonarLint is a free and open source IDE extension that identifies and catches bugs and vulnerabilities as you code, directly in the IDE. Install from your favorite IDE marketplace today.

  • docs-deploy

    Deploys a VuePress docs repo to GitHub Pages

    Here's the deploy repo https://github.com/chevere/docs-deploy

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts