{"id":27393841,"url":"https://github.com/geooot/request-catwalk","last_synced_at":"2025-10-19T19:07:21.511Z","repository":{"id":47991924,"uuid":"197245831","full_name":"geooot/request-catwalk","owner":"geooot","description":"👠 Strut your API Stuff! Create simple HTML pages to show off your API","archived":false,"fork":false,"pushed_at":"2022-12-04T03:40:15.000Z","size":170,"stargazers_count":5,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-13T22:15:58.883Z","etag":null,"topics":["cli","presentations","request-catwalk","rest-client","tool"],"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/geooot.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":"2019-07-16T18:17:26.000Z","updated_at":"2020-07-19T00:10:58.000Z","dependencies_parsed_at":"2023-01-24T00:00:28.064Z","dependency_job_id":null,"html_url":"https://github.com/geooot/request-catwalk","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geooot%2Frequest-catwalk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geooot%2Frequest-catwalk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geooot%2Frequest-catwalk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geooot%2Frequest-catwalk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/geooot","download_url":"https://codeload.github.com/geooot/request-catwalk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248788806,"owners_count":21161728,"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":["cli","presentations","request-catwalk","rest-client","tool"],"created_at":"2025-04-13T22:16:02.707Z","updated_at":"2025-10-19T19:07:21.434Z","avatar_url":"https://github.com/geooot.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# request-catwalk\n👠 Strut your API Stuff!\n\nThis CLI generates pages that allow you to create a form for your APIs without having to do it yourself. Great for making a presentation showing off some API\n\nCurrently this only works with GET requests and Query String parameters.\n\n## Installation\n\nThis repo uses the new fancy [GitHub Package Registry](https://github.com/features/package-registry)\n\nBefore installing, make sure to authenticate with GitHub Package Registry or using a `.npmrc` file. See \"[Configuring npm for use with GitHub Package Registry](https://help.github.com/en/articles/configuring-npm-for-use-with-github-package-registry#authenticating-to-github-package-registry).\"\n\n\n`$ npm install @geooot/request-catwalk`\n\nOr add this package to your `package.json` file:\n\n```\n\"dependencies\": {\n    \"@geooot/request-catwalk\": \"1.0.0\"\n}\n```\n\n## Usage\n```\nUSAGE\n  $ catwalk [COMMAND]\n\nCOMMANDS\n  build   build a request page for a request definition json file\n  help    display help for catwalk\n  server  build a request page for a request definition json file then serve it on a page\n```\n\n### `$ catwalk build`\n```\nUSAGE\n  $ catwalk build [FILE]\n\nOPTIONS\n  -h, --help           show CLI help\n  -o, --output=output  Output file to write generated HTML (if not specified, output will be stdout)\n\nEXAMPLE\n  $ catwalk build definition.json\n```\n\n### `$ catwalk server`\n```\nUSAGE\n  $ catwalk server [FILE]\n\nOPTIONS\n  -h, --help       show CLI help\n  -p, --port=port  network port to serve catwalk page. (Default: 8080)\n\nEXAMPLE\n  $ catwalk server definition.json\n```\n\n## Definition Schema\n```\n{\n    \"requestType\": \"GET\",   // TODO: add more\n    \"url\": string           // Url endpoint to call\n    \"queryParams\": {\n        \"someQueryParameterName\": { // These objects are called Configurables, String Configurable and Json Configurable have more options\n            \"type\": \"BOOL\" | \"STRING\" | \"JSON\",\n            \"name\": string  // optional\n        }\n        \"hereIsAShortHand\": \"BOOL\" | \"STRING\" | \"JSON\"  // You can quickly just assign types without defining the name or other options\n    }\n}\n```\n\n### String Configurable\nYou can define `options` which limits whats strings can be typed to those specified options.\n```\n{\n    \"type\": \"STRING\",\n    \"name\": \"Some pretty name to make this human readable\"  // optional\n    \"options\": [    // optional\n        \"One\",\n        \"Two\",\n        \"Three\n    ]\n}\n```\n\nEach option can also specify its own name and value sepperately\n```\n{\n    \"type\": \"STRING\",\n    \"name\": \"Some pretty name to make this human readable\"  // optional\n    \"options\": [    // optional\n        {\"name\": \"Some pretty name\", \"value\": \"theActualValueSentToServer\"},\n        \"Two\",\n        \"Three\n    ]\n}\n```\n\n### JSON Configurable\nYou can define `data` which is an object containing Configurables to be added to a JSON object. For query parameters the JSON object will be stringified and added to the query string.\n```\n{\n    \"type\": \"JSON\",\n    \"name\": \"Some pretty name to make this human readable\"  // optional\n    \"data\": {\n        \"hereIsABoolConfigurable\": \"BOOL\",\n        \"anotherCoolKey\": {\n            \"type\": \"STRING\"\n            \"name\": \"How cool are you?\",\n            \"options\": [\n                \"Super Cool\",\n                \"Extremely Cool\",\n                \"Borderline Frostbite\"\n            ]\n        }\n    }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeooot%2Frequest-catwalk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeooot%2Frequest-catwalk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeooot%2Frequest-catwalk/lists"}