{"id":39891145,"url":"https://github.com/lambda2/apiize","last_synced_at":"2026-01-18T14:42:48.440Z","repository":{"id":57182101,"uuid":"60331959","full_name":"lambda2/apiize","owner":"lambda2","description":"Turn json files into explorable API's","archived":false,"fork":false,"pushed_at":"2016-06-25T17:38:23.000Z","size":3291,"stargazers_count":45,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-10-19T23:39:20.627Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/lambda2.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-06-03T08:33:59.000Z","updated_at":"2024-05-25T15:14:39.000Z","dependencies_parsed_at":"2022-09-14T06:01:27.787Z","dependency_job_id":null,"html_url":"https://github.com/lambda2/apiize","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lambda2/apiize","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lambda2%2Fapiize","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lambda2%2Fapiize/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lambda2%2Fapiize/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lambda2%2Fapiize/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lambda2","download_url":"https://codeload.github.com/lambda2/apiize/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lambda2%2Fapiize/sbom","scorecard":{"id":577896,"data":{"date":"2025-08-11","repo":{"name":"github.com/lambda2/apiize","commit":"3994efacbf31372b96cc69cca922d4dadbe180a4"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}}]},"last_synced_at":"2025-08-20T18:20:35.598Z","repository_id":57182101,"created_at":"2025-08-20T18:20:35.598Z","updated_at":"2025-08-20T18:20:35.598Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28538294,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T13:04:05.990Z","status":"ssl_error","status_checked_at":"2026-01-18T13:01:44.092Z","response_time":98,"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":[],"created_at":"2026-01-18T14:42:48.222Z","updated_at":"2026-01-18T14:42:48.428Z","avatar_url":"https://github.com/lambda2.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# apiize [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage percentage][coveralls-image]][coveralls-url]\n\n**Turn any JSON file into a full, explorable, REST API.**\n\n## Presentation\n\n#### Start apiize on a JSON file or url\n\n![cli-demo](https://raw.githubusercontent.com/lambda2/apiize/master/images/apiize-cli.gif)\n\n#### And make requests on it\n\n![cli-demo](https://raw.githubusercontent.com/lambda2/apiize/master/images/apiize-example.gif)\n\n\n## Install\n\n```sh\n$ npm install -g apiize\n```\n\n\n## Command line usage\n\n- Start a new server on a given JSON file or url\n\n```bash\n$ apiize 'https://raw.githubusercontent.com/lambda2/apiize/master/test/datasets/punchlines.json'\n\n  ___        _ _\n / _ \\      (_|_)\n/ /_\\ \\_ __  _ _ _______\n|  _  | '_ \\| | |_  / _ \\\n| | | | |_) | | |/ /  __/\n\\_| |_/ .__/|_|_/___\\___|\n      | |\n      |_|\n\n💫  Express has taken the stage and is listening on port 1313\n\n∙ GET /api/contents Return all the contents\n∙ GET /api/contents/:id Return the given contents\n∙ GET /api/tags Return all the tags\n∙ GET /api/tags/:id Return the given tags\n∙ GET /api/authors Return all the authors\n∙ GET /api/authors/:id Return the given authors\n∙ GET /api/albums Return all the albums\n∙ GET /api/albums/:id Return the given albums\n∙ GET /api/titles Return all the titles\n∙ GET /api/titles/:id Return the given titles\n∙ GET /api/ Return all items\n∙ GET /api/random A random item\n\n```\n\n- Make requests on it\n\n```bash\n$ curl -H \"Accept: application/json\" \"localhost:1313/\"\n\n{\"endpoints\":[{\"url\":\"/api/contents\",\"description\":\"Return all the contents\"},{\"url\":\"/api/contents/:id\",\"description\":\"Return the given contents\"},{\"url\":\"/api/tags\",\"description\":\"Return all the tags\"},{\"url\":\"/api/tags/:id\",\"description\":\"Return the given tags\"},{\"url\":\"/api/authors\",\"description\":\"Return all the authors\"},{\"url\":\"/api/authors/:id\",\"description\":\"Return the given authors\"},{\"url\":\"/api/albums\",\"description\":\"Return all the albums\"},{\"url\":\"/api/albums/:id\",\"description\":\"Return the given albums\"},{\"url\":\"/api/titles\",\"description\":\"Return all the titles\"},{\"url\":\"/api/titles/:id\",\"description\":\"Return the given titles\"},{\"url\":\"/api/\",\"description\":\"Return all items\"},{\"url\":\"/api/random\",\"description\":\"A random item\"}]}%\n```\n\n## Usage\n\n```js\nconst Apiize = require('apiize');\n\n// Here is the default options\nconst options = {\n  verbose: false, // Output more verbose requests\n  prefix: 'api', // The root endpoint of the API\n  port: 1313 // The express server port.\n};\n\n// Turn the 'http://example.org/file.json' file into an API\nlet apiize = new Apiize('http://example.org/file.json', options);\n\n// When apiize is ready\napiize.on('ready', function (server) {\n  server.serve(); // run the server\n});\n\n```\n\n## API\n\n```js\nvar Apiize = require('apiize');\n\nvar api = new Apiize(link, options);\n```\n\n------------------\n\n### Events\n\n#### ready\n\nTriggered when the file or the link is fully loaded, and the express server is ready to be started.\n\n```js\nvar api = new Apiize(link, options);\napi.on('ready', function (server) {\n  server.serve(); // run the server\n});\n\n```\n\n\n------------------\n\n### Methods\n\n#### new Apiize(link, options)\n\nCreate a new Apiize object using the given `link` and `options`.\nThe `link` argument must be a string of a JSON file or a JSON URL.\n\n\u003e Apiize accepts these properties in the options object.\n\n- verbose\n\n  \u003e Defaults to `false`, add a more verbose logging of incoming requests.\n\n  - Without `verbose`:\n  `GET / 200 146 - 6.079 ms`\n\n  - With `verbose`:\n  `::1 - - [25/Jun/2016:15:41:06 +0000] \"GET / HTTP/1.1\" 200 750 \"-\" \"curl/7.43.0\"`\n\n- prefix\n\n  \u003e Set the root path of the generated api routes. Defaults to `api`.\n\n- port\n\n  \u003e Set the express server port. Defaults to `1313`.\n\n#### on(event, callback)\n\nTriggered when an event is emmmited (e.g., the `ready` event).\n\n#### serve()\n\nStart the express server. Must be called when the `ready` event is called.\n\n\n------------------\n\n## Tests\n\n  To run the test suite, first install the dependencies, then run `npm test`:\n\n```bash\n$ npm install\n$ npm test\n```\n\n## People\n\n[André Aubin](https://github.com/lambda2) [![Andre's Gratipay][gratipay-image-lambda2]][gratipay-url-lambda2]\n\n[List of all contributors](https://github.com/lambda2/apiize/graphs/contributors)\n\n## License\n\nMIT © [Andre Aubin](http://andral.kiwi)\n\n\n[npm-image]: https://badge.fury.io/js/apiize.svg\n[npm-url]: https://npmjs.org/package/apiize\n[travis-image]: https://travis-ci.org/lambda2/apiize.svg?branch=master\n[travis-url]: https://travis-ci.org/lambda2/apiize\n[daviddm-image]: https://david-dm.org/lambda2/apiize.svg?theme=shields.io\n[daviddm-url]: https://david-dm.org/lambda2/apiize\n[coveralls-image]: https://coveralls.io/repos/github/lambda2/apiize/badge.svg?branch=master\n[coveralls-url]: https://coveralls.io/github/lambda2/apiize?branch=master\n[gratipay-image-lambda2]: https://img.shields.io/gratipay/lambda2.svg\n[gratipay-url-lambda2]: https://gratipay.com/lambda2/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flambda2%2Fapiize","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flambda2%2Fapiize","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flambda2%2Fapiize/lists"}