{"id":37266258,"url":"https://github.com/negreanucalin/multidoc-parser","last_synced_at":"2026-01-16T00:33:33.262Z","repository":{"id":21050435,"uuid":"92172251","full_name":"negreanucalin/multidoc-parser","owner":"negreanucalin","description":"Parse Multidoc documentation (YAML for mow)","archived":false,"fork":false,"pushed_at":"2021-11-24T17:08:26.000Z","size":441,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-21T03:06:36.930Z","etag":null,"topics":["documentation","documentation-generation"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/negreanucalin.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-05-23T12:49:48.000Z","updated_at":"2024-01-05T15:41:24.000Z","dependencies_parsed_at":"2022-07-27T01:16:52.183Z","dependency_job_id":null,"html_url":"https://github.com/negreanucalin/multidoc-parser","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/negreanucalin/multidoc-parser","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/negreanucalin%2Fmultidoc-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/negreanucalin%2Fmultidoc-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/negreanucalin%2Fmultidoc-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/negreanucalin%2Fmultidoc-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/negreanucalin","download_url":"https://codeload.github.com/negreanucalin/multidoc-parser/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/negreanucalin%2Fmultidoc-parser/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28421234,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T13:30:50.153Z","status":"ssl_error","status_checked_at":"2026-01-14T13:29:08.907Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation","documentation-generation"],"created_at":"2026-01-16T00:33:32.073Z","updated_at":"2026-01-16T00:33:33.210Z","avatar_url":"https://github.com/negreanucalin.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Multidoc Parser\n\n#### Check out [Multidoc viewer](https://github.com/negreanucalin/multidoc-viewer)\n#### Did you say [Laravel?](https://github.com/negreanucalin/multidoc-laravel)\n\n### Testing\nJust manual-functional testing for now  provided in folder `demo_files` by running `index.php` and check the output\n\n### TODO list\n\n* Define mandatory and optional parameters by adding demo files\n* Validate route params\n    1. If FILE and JSON or named POST variables present throw error (only 1 of them)\n    2. Parameter type validation (from list:uri,post, get)\n    3. GET cannot have JSON and FILE\n    4. Route validation:\n        I. If parameter present in route check if it exists in list\n        II. If parameter present check if uri\n* Parses `*.yaml` files and generates a flat document containing the application's documentation\n* \n### Notes\n* No filename convention required\n* You can organize however you want\n* A sugestion would be to have multiple files:\n\t* `_project.yaml` - Project description\n\t* `_categories.yaml` - Menu items and sub-items\n\t* `user_route.yaml` - Route example\n\t* `another_route.yaml` - Route example\n\t\t\n* Project\n    * File name `_my_awesome_project.yaml`\n```\nproject:\n  name: My Awesome project\n  version: 1\n  description: Some awesome description\n  environments:\n    default: https://wwww.myproductionurl.com\n    preprod: https://www.mypreproductionurl.com\n```\n\t\t\n* Categories\n\t* File name `_my_awesome_categories.yaml`\n```\ncategories:\n  cat1:\n    name: Cat 1\n    categories:\n      cat2:\n        name: Cat 2\n  cat3:\n      name: Cat 3\n  cat4:\n      name: Cat 4\n```\n\n* Route example\n\t* File name `user_route.yaml`\n```\nroute:\n  name: Some route 1\n  description: Some desc 1\n  tags: [tag1, tag2, tag3, tag4, tag5]\n  category: cat1\n  request:\n      url: '{{environment}}/[:typeEntity][/:page]/comments'\n      method: GET\n      params:\n        - name: typeEntity\n          type: uri\n          data_type: string\n          description: Some desc\n          optional: false\n          example: posts\n        - name: page\n          type: uri\n          data_type: int\n          description: Some desc\n          optional: true\n          example: 1\n```\n\n* Multiple routes example\n\t* File name `some_routes.yaml`\n```\nroute_list:\n  - name: Some route 2\n    description: Some desc 2\n    tags: [tag1, tag2, tag3, tag4, tag 5]\n    category: cat1\n    request:\n        url: '{{environment}}/[:typeEntity][/:page]/comments'\n        method: GET\n        params:\n          - name: typeEntity\n            type: uri\n            data_type: string\n            description: Some desc\n            optional: false\n            example: posts\n          - name: page\n            type: uri\n            data_type: int\n            description: Some desc\n            optional: true\n            example: 1\n  - name: Some route 3\n    description: Some desc 3\n    request:\n        url: '{{environment}}/users/2/comments'\n        method: GET\n    tags: [tag3, tag4]\n    category: cat2\n  - name: Some route 4\n    description: Some desc 4\n    tags: [tag3, tag4]\n    category: cat2\n    request:\n        url: '{{environment}}/[:typeEntity][/:page]/comments'\n        method: GET\n    params:\n      - name: typeEntity\n        type: uri\n        data_type: string\n        description: Some desc\n        optional: false\n        example: posts\n        possible_values: [posts,test]\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnegreanucalin%2Fmultidoc-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnegreanucalin%2Fmultidoc-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnegreanucalin%2Fmultidoc-parser/lists"}