{"id":27314143,"url":"https://github.com/ubirak/jadd","last_synced_at":"2025-06-24T04:03:55.896Z","repository":{"id":57065283,"uuid":"65559901","full_name":"ubirak/jadd","owner":"ubirak","description":"Jadd is Another Documentation Dumper","archived":false,"fork":false,"pushed_at":"2017-02-05T17:59:33.000Z","size":31,"stargazers_count":3,"open_issues_count":7,"forks_count":3,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-04-27T19:05:35.934Z","etag":null,"topics":["automation","documentation-dumper","living-documentation","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ubirak.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-12T14:36:41.000Z","updated_at":"2017-11-29T20:38:13.000Z","dependencies_parsed_at":"2022-08-24T14:01:26.287Z","dependency_job_id":null,"html_url":"https://github.com/ubirak/jadd","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubirak%2Fjadd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubirak%2Fjadd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubirak%2Fjadd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubirak%2Fjadd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ubirak","download_url":"https://codeload.github.com/ubirak/jadd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248536370,"owners_count":21120681,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","documentation-dumper","living-documentation","php"],"created_at":"2025-04-12T07:39:36.696Z","updated_at":"2025-04-12T07:39:37.159Z","avatar_url":"https://github.com/ubirak.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JADD [![Build Status](https://travis-ci.org/rezzza/jadd.svg?branch=master)](https://travis-ci.org/rezzza/jadd)\nJadd : Another Documentation Dumper\n\n## Why ?\n\n- Because we love reading documentation on REST API.\n- We really don't like writing documentation.\n- We really don't like updating documentation.\n- Annotations are evil\n\n## How ?\n\n2 steps are needed\n\n### Collect the responses during functional tests\n\nOf course you have tests for your API. So why not connecting to it and record all the cases you test ?\n\nIf you use [php-http](http://php-http.org), we provide a [middleware to collect the data](https://github.com/rezzza/jadd/blob/master/src/Infra/Http/CollectEndpointPlugin.php) during your tests. [Have a look on the test](https://github.com/rezzza/jadd/blob/master/features/collect_endpoint.feature#L41) to be sure how to use it.\n\n### Consolidate routing file\n\nThen just need to run the `bin/jadd generate \u003cmyRoutingFile\u003e \u003coutputFile\u003e`\n\nIt will parse your routes and consolidate the responses with tests recording.\n\nBest place would be in `onSuccess` hook of your CI.\n\n## Install\n\nFor now, we support only install on PHP project through composer :\n```\ncomposer require --dev rezzza/jadd:dev-master\n```\n\n## Routing supported\n\n- Symfony YAML (Don't support YAML + `@Route` Annotation in Controller)\n\n## Output supported\n\n- [APIBlueprint](https://apiblueprint.org/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubirak%2Fjadd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fubirak%2Fjadd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubirak%2Fjadd/lists"}