{"id":28225636,"url":"https://github.com/typeaware/oredoc","last_synced_at":"2026-05-16T11:34:19.868Z","repository":{"id":95713264,"uuid":"157641962","full_name":"TypeAware/oredoc","owner":"TypeAware","description":"Node.js ApiDoc generator (programmatic)","archived":false,"fork":false,"pushed_at":"2018-12-06T06:58:21.000Z","size":1528,"stargazers_count":1,"open_issues_count":19,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-11T06:20:59.138Z","etag":null,"topics":["api","developer-experience","docs","documentation-generator","dx","nodejs","programmatic","restful-api"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/TypeAware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-11-15T02:42:45.000Z","updated_at":"2018-12-06T06:58:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"a72603ae-60c0-4af5-9e87-7b0e4bdc4e72","html_url":"https://github.com/TypeAware/oredoc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/TypeAware/oredoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeAware%2Foredoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeAware%2Foredoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeAware%2Foredoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeAware%2Foredoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TypeAware","download_url":"https://codeload.github.com/TypeAware/oredoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeAware%2Foredoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33100912,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-16T04:41:52.686Z","status":"ssl_error","status_checked_at":"2026-05-16T04:41:52.009Z","response_time":115,"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":["api","developer-experience","docs","documentation-generator","dx","nodejs","programmatic","restful-api"],"created_at":"2025-05-18T11:09:18.796Z","updated_at":"2026-05-16T11:34:19.863Z","avatar_url":"https://github.com/TypeAware.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n### OreDoc: @oresoftware/doc \u0026 oredoc\n\n\nTo use OreDoc, you would write code resembling:\n\n\n```typescript\nimport * as express from 'express';\nimport {RequestHandler} from 'express';\nimport {DocGen, Entity, Route, RouteBase, RouteMulti} from '../dist/main';\n\nconst router = express.Router();\nconst doc = new DocGen();\n\nexport const register = (v: any) =\u003e {\n  const entity = doc.createAndAddEntity('foo');\n  router.get('/', makeGetFoo(v, entity));\n  router.put('/', makePutFoo(v, entity));\n};\n\n\nconst makeGetFoo = (v: any, e: Entity): RequestHandler =\u003e {\n  \n  const r = new RouteMulti({\n    headers: {},\n    body: {}\n  }, {\n    body: {\n      success: {\n        foo: 'yes'\n      }\n    }\n  });\n  \n  //\n  \n  type SuccessResponse = typeof r.res.body.success;\n  \n  e.addRoute({\n    path: '',\n    example: r\n  });\n  \n  return (req, res, next) =\u003e {\n    \n    const headers = req.headers.foo;\n    \n    res.json(\u003cSuccessResponse\u003e {foo: ''});\n    \n  };\n  \n};\n\nconst makePutFoo = (v: any, e: Entity): RequestHandler =\u003e {\n  \n  interface Response {\n  \n  }\n  \n  return (req, res, next) =\u003e {\n    \n    res.json(\u003cResponse\u003e{success: 'f'});\n    \n  };\n  \n};\n\n\n\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypeaware%2Foredoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypeaware%2Foredoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypeaware%2Foredoc/lists"}