PHPackages ublaboo/anabelle - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. ublaboo/anabelle Abandoned β†’ [contributte/anabelle](/?search=contributte%2Fanabelle)ArchivedLibrary[API Development](/categories/api) ublaboo/anabelle ================ JSON-RPC Api documentation generator v5.0.0(2y ago)249.4k7MITPHPPHP >=8.1CI failing Since Nov 21Pushed 4mo ago3 watchersCompare [ Source](https://github.com/contributte/anabelle)[ Packagist](https://packagist.org/packages/ublaboo/anabelle)[ Docs](https://contributte.org/anabelle)[ Fund](https://contributte.org/partners.html)[ GitHub Sponsors](https://github.com/f3l1x)[ RSS](/packages/ublaboo-anabelle/feed)WikiDiscussions master Synced 3d ago READMEChangelog (10)Dependencies (8)Versions (37)Used By (0) [![](https://camo.githubusercontent.com/499d088f6583a6f37340ef2b847685037d45e1a7dcb6c747692230f338b07dc3/68747470733a2f2f686561746261646765722e6e6f772e73682f6769746875622f726561646d652f636f6e74726962757474652f616e6162656c6c652f3f646570726563617465643d31)](https://camo.githubusercontent.com/499d088f6583a6f37340ef2b847685037d45e1a7dcb6c747692230f338b07dc3/68747470733a2f2f686561746261646765722e6e6f772e73682f6769746875622f726561646d652f636f6e74726962757474652f616e6162656c6c652f3f646570726563617465643d31) [![](https://camo.githubusercontent.com/a8b1cd856d7d396fdebbe46947cc3507490acc267a02361e5e53bb7b820c95c3/68747470733a2f2f62616467656e2e6e65742f62616467652f737570706f72742f6769747465722f6379616e)](https://bit.ly/ctteg) [![](https://camo.githubusercontent.com/86d6416fc04f8bcc3daa7bf881526b9953b9726b1164d05c157c8713e3a73418/68747470733a2f2f62616467656e2e6e65742f62616467652f737570706f72742f666f72756d2f79656c6c6f77)](https://bit.ly/cttfo) [![](https://camo.githubusercontent.com/5d170ab94e6d594609561e16fe0f9e4293968fbd4dfcfafc5e11efc1415ef09c/68747470733a2f2f62616467656e2e6e65742f62616467652f73706f6e736f722f646f6e6174696f6e732f463936383534)](https://contributte.org/partners.html) Website πŸš€ [contributte.org](https://contributte.org) | Contact πŸ‘¨πŸ»β€πŸ’» [f3l1x.io](https://f3l1x.io) | Twitter 🐦 [@contributte](https://twitter.com/contributte) Disclaimer ---------- [](#disclaimer) ⚠️This project is no longer being maintained.Composer[`contributte/anabelle`](https://packagist.org/packages/contributte/anabelle)Version[![](https://camo.githubusercontent.com/d1849d212ecb069b26136418f7ffdcadf59bc700382be45b2e6d18da55f9eee9/68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f762f636f6e74726962757474652f616e6162656c6c65)](https://camo.githubusercontent.com/d1849d212ecb069b26136418f7ffdcadf59bc700382be45b2e6d18da55f9eee9/68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f762f636f6e74726962757474652f616e6162656c6c65)PHP[![](https://camo.githubusercontent.com/e1e6900704cff44038f20e8dc4d26461b740fea627a768f80beaa6848ff0896a/68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f7068702f636f6e74726962757474652f616e6162656c6c65)](https://camo.githubusercontent.com/e1e6900704cff44038f20e8dc4d26461b740fea627a768f80beaa6848ff0896a/68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f7068702f636f6e74726962757474652f616e6162656c6c65)License[![](https://camo.githubusercontent.com/1e3158bc256a44d725e1f8d3382919a9079a5d126f7cff357470bc7509708a71/68747470733a2f2f62616467656e2e6e65742f6769746875622f6c6963656e73652f636f6e74726962757474652f616e6162656c6c65)](https://camo.githubusercontent.com/1e3158bc256a44d725e1f8d3382919a9079a5d126f7cff357470bc7509708a71/68747470733a2f2f62616467656e2e6e65742f6769746875622f6c6963656e73652f636f6e74726962757474652f616e6162656c6c65) [![](https://github.com/contributte/anabelle/raw/master/assets/anabelle.png)](https://github.com/contributte/anabelle/blob/master/assets/anabelle.png) About ----- [](#about) Anabelle is a JSON-RPC API documentation generator. It supports both JSON-RPC and REST architectures and provides an extended Markdown syntax for creating rich, interactive API documentation. Usage ----- [](#usage) To install the latest version of `contributte/anabelle` use [Composer](https://getcomposer.org). ``` composer require contributte/anabelle ``` How to use anabelle ------------------- [](#how-to-use-anabelle) ``` cd myApi composer require contributte/anabelle vendor/bin/anabelle docs-src docs ``` ### CLI options [](#cli-options) #### Automatically overwrite output directory [](#automatically-overwrite-output-directory) ``` vendor/bin/anabelle docs-src docs -o // Or vendor/bin/anabelle docs-src docs --overwriteOutputDir ``` #### Add http auth to generated files [](#add-http-auth-to-generated-files) **Beware! Anabelle generates by default .html files. If you are using http auth, it generates .php files due to the need of validating http auth headers.** ``` vendor/bin/anabelle docs-src docs -u user -p pass // Or vendor/bin/anabelle docs-src docs --httpAuthUser user -httpAuthPass pass ``` Extended Markdown syntax ------------------------ [](#extended-markdown-syntax) ### `#include ` [](#include-filemd) ``` #include variables.md ``` ### `$variable = ` [](#variable--value) ``` $uuid = 123e4567-e89b-12d3-a456-426655440000 ``` Inline variable usage ``` User uuid is {$uuid} ``` ### `$$blockVariable ... $$` [](#blockvariable--) ``` $$successEmptyResponse { "jsonrpc": "2.0", "result": {}, "id": null } $$ ``` Block variable usage ``` Server returns response: {$$successEmptyResponse} ``` ### `@ :` [](#-sectionnamesectionfilemd) High-level section definition. This macro available only in `index.md` file. ``` @ Home:home.md @ About project:about.md ``` ### `@@ :` [](#-sectionnamesectionfilemd-1) Method section definition. This macro available only in `index.md` file. ``` @@ user.login:methods/user.login.md @@ user.logout:methods/user.logout.md @@ user.register:methods/user.register.md @@ user.confirm-registration:methods/user.confirm-registration.md ``` ### `[File link](foo/bar/data.json)` [](#file-linkfoobardatajson) [File link](foo/bar/data.json) will create a link to file (`foo/bar/data.json`). The file will be copied to documentation output directory for safety reasons. ``` [File link](foo/bar/data.json) [Project root directory file link](../app/schema/user.json) ``` Generator workflow ------------------ [](#generator-workflow) 1. Most important (and only required) file is `index.md`. In this file, you can use only (different Markdown markup is ignored in `index.md`): - `# ` - `## ` - `#include ` - `$variable = ` - `$$blockVariable ... $$` - `@ :` - `@@ :`) 2. `#include` macros are replaced 3. `` is used as documentation page title (only the first found one is used) 4. `` can be used wherever you want in the sidebar 5. `@` and `@@` sections are rendered in the sidebar nav 6. Content of `@` and `@@` sections is rendered into separate files and loaded into the main section detail after clicking particular section link in the nav Examples -------- [](#examples) - (example project) - (generated documentation) - (playground) - (more examples) Versions -------- [](#versions) StateVersionBranchNettePHPdev`^6.0.0``master``3.0+``>=8.1`stable`^5.0.0``master``3.0+``>=8.1`Development ----------- [](#development) This package was maintained by these authors. [ ![](https://avatars2.githubusercontent.com/u/1488874?v=3&s=80)](https://github.com/paveljanda)--- Consider to [support](https://contributte.org/partners.html) **contributte** development team. Also thank you for using this package. ### Health Score 50 β€” FairBetter than 96% of packages Maintenance51 Moderate activity, may be stable Popularity32 Limited adoption so far Community17 Small or concentrated contributor base Maturity84 Battle-tested with a long release history Bus Factor1 Top contributor holds 76.1% of commits β€” single point of failure How is this calculated?**Maintenance (25%)** β€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** β€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** β€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** β€” Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~62 days Recently: every ~366 days Total 36 Last Release 911d ago Major Versions v1.6.0 β†’ v2.0.02019-09-09 v2.2.0 β†’ v3.0.02020-05-04 v3.0.0 β†’ v4.0.02022-01-06 v4.0.0 β†’ v5.0.02023-11-15 PHP version history (3 changes)v1.0.0PHP >= 7.1.0 v4.0.0PHP >= 8.0 v5.0.0PHP >=8.1 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/538058?v=4)[Milan Ε ulc](/maintainers/f3l1x)[@f3l1x](https://github.com/f3l1x) ![](https://avatars.githubusercontent.com/u/1488874?v=4)[Pavel Janda](/maintainers/paveljanda)[@paveljanda](https://github.com/paveljanda) --- Top Contributors [![paveljanda](https://avatars.githubusercontent.com/u/1488874?v=4)](https://github.com/paveljanda "paveljanda (83 commits)")[![f3l1x](https://avatars.githubusercontent.com/u/538058?v=4)](https://github.com/f3l1x "f3l1x (21 commits)")[![pilec](https://avatars.githubusercontent.com/u/557455?v=4)](https://github.com/pilec "pilec (3 commits)")[![petrparolek](https://avatars.githubusercontent.com/u/6066243?v=4)](https://github.com/petrparolek "petrparolek (2 commits)") --- Tags apicontributtenette-frameworkjsonapirpcdocumentationgeneratorjson-rpcdocsreadme ### Embed Badge ![Health badge](/badges/ublaboo-anabelle/health.svg) ``` [![Health](https://phpackages.com/badges/ublaboo-anabelle/health.svg)](https://phpackages.com/packages/ublaboo-anabelle) ``` ### Alternatives [apigen/apigen PHP source code API generator. 2.2k627.9k225](/packages/apigen-apigen)[binarytorch/larecipe Generate gorgeous recipes for your Laravel applications using MarkDown 2.5k2.7M16](/packages/binarytorch-larecipe)[jsonrpc/jsonrpc JSON-RPC 2.0 client/server implementation 53407.1k4](/packages/jsonrpc-jsonrpc)[tivoka/tivoka The universal JSON-RPC client/server library. JSON-RPC done right! 74159.0k3](/packages/tivoka-tivoka)[ufo-tech/json-rpc-sdk-bundle The Symfony bundle for simple usage Json-RPC api with dynamic SDK 172.5k](/packages/ufo-tech-json-rpc-sdk-bundle)[ufo-tech/rpc-exceptions Exception package RPC server error codes 164.2k4](/packages/ufo-tech-rpc-exceptions) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)