{"id":30770232,"url":"https://github.com/hwisnu222/hyrapi","last_synced_at":"2026-05-15T21:10:43.594Z","repository":{"id":308301262,"uuid":"1032245317","full_name":"hwisnu222/hyrapi","owner":"hwisnu222","description":"A simple CLI REST API client using YAML collections","archived":false,"fork":false,"pushed_at":"2025-08-07T06:51:01.000Z","size":808,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-04T23:15:08.988Z","etag":null,"topics":["api-tool","cli","developer-tools","http-client","python","rest","rest-api","rest-client","yaml"],"latest_commit_sha":null,"homepage":"https://hwisnu222.github.io/hyrapi/","language":"Python","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/hwisnu222.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-05T03:21:51.000Z","updated_at":"2025-08-07T06:50:48.000Z","dependencies_parsed_at":"2025-08-05T08:48:33.053Z","dependency_job_id":null,"html_url":"https://github.com/hwisnu222/hyrapi","commit_stats":null,"previous_names":["hwisnu222/hyrapi"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/hwisnu222/hyrapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hwisnu222%2Fhyrapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hwisnu222%2Fhyrapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hwisnu222%2Fhyrapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hwisnu222%2Fhyrapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hwisnu222","download_url":"https://codeload.github.com/hwisnu222/hyrapi/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hwisnu222%2Fhyrapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33080600,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-15T20:25:35.270Z","status":"ssl_error","status_checked_at":"2026-05-15T20:25:34.732Z","response_time":103,"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-tool","cli","developer-tools","http-client","python","rest","rest-api","rest-client","yaml"],"created_at":"2025-09-04T23:03:26.271Z","updated_at":"2026-05-15T21:10:43.590Z","avatar_url":"https://github.com/hwisnu222.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003eHyrapi\u003c/h1\u003e\n  \u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/CLI-Rest%20API-green?style=flat-square\" alt=\"Badge\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Version-v1.3.0-orange?style=flat-square\" alt=\"Badge\"\u003e\n  \u003c/div\u003e\n\u003c/div\u003e\n\nHyrapi is a CLI-based REST API client powered by a YAML collection file. It's designed to simplify making HTTP requests by organizing endpoints, headers, tokens, and parameters in a single configuration file.\n\n![path](./assets/path-list.png)\n![request](./assets/request.png)\n\n## Installation\n\nYou can install `hyr` in two ways:\n\n### Method 1: Manual Installation\n\n```bash\ngit clone https://github.com/hwisnu222/hyrapi.git\ncd hyrapi\nmake build\ncd dist/\nchmod +x hyr\nsudo mv hyr /usr/local/bin/\n```\n\n### Method 2: One-Line Install Script\n\n```bash\ncurl -fsSL https://raw.githubusercontent.com/hwisnu222/hyrapi/main/install.sh | sh\n```\n\n## Usage\n\nTo use `hyrapi`, you need to provide a YAML collection file:\n\n```bash\nhyr -c collections.yml\n```\n\n## Sample `collections.yml`\n\n```yaml\nservers:\n  - url: http://localhost:3000/api/v1\n    name: development\n    description: development server\n  - url: http://example.com/api/v1\n    name: staging\n    description: staging server\n  - url: http://example.com/api/v1\n    name: production\n    description: production server\n\nvariables:\n  global_variable: value\n  development:\n    token: value\n  staging:\n    token: value\n  production:\n    token: value\n\npaths:\n  - endpoint: /incomes\n    name: getIncomes\n    method: GET\n    auth:\n      type: bearer\n      token: \"{{token}}\"\n    headers:\n      Content-Type: application/json\n\n  - endpoint: /incomes/4\n    name: deleteIncomes\n    method: DELETE\n    auth:\n      type: bearer\n      token: \"{{token}}\"\n    headers:\n      Content-Type: application/json\n```\n\n## Structure Explained\n\n### `servers`\n\nDefines base URLs for your API. You can use multiple environments (dev, staging, prod).\n\n### `variables`\n\nDeclare reusable variables like tokens, API keys, etc.\n\n### `paths`\n\nList of API requests:\n\n- `endpoint`: the path to the API route\n- `name`: a label to identify this request\n- `method`: HTTP method (`GET`, `POST`, `PUT`, `DELETE`, etc.)\n- `auth`: authentication configuration\n  - `type`: `bearer` (currently supported)\n  - `token`: value or reference using `{{variable}}`\n- `headers`: optional headers to send with the request\n\n### Authentication (`auth`)\n\nThe `auth` section allows you to configure how each request is authenticated. Below are the supported types and their configuration:\n\n#### Bearer Token\n\n```yaml\nauth:\n  type: bearer\n  token: \"{{token}}\"\n```\n\nSends an `Authorization: Bearer \u003ctoken\u003e` header.\n\n#### Basic Auth\n\n```yaml\nauth:\n  type: basic\n  username: admin\n  password: secret\n```\n\nSends an `Authorization: Basic \u003cbase64-encoded-credentials\u003e` header.\n\n#### API Key (Header-based)\n\n```yaml\nauth:\n  type: apikey\n  api_key: abc123\n  api_key_header: X-API-Key\n```\n\nSends `X-API-Key: abc123` in the request header. The header name can be customized using `api_key_header`.\n\n#### Digest Auth\n\n```yaml\nauth:\n  type: digest\n  username: admin\n  password: secret\n```\n\nSupports HTTP Digest Authentication.\n\n## Features\n\n- YAML-based API collection\n- Built-in support for Bearer Token authentication\n- Easily switch between environments\n- CLI interface for fast request execution\n\n## Roadmap Ideas (Planned Features)\n\n- Support for:\n  - `basic` and `custom` auth types\n  - Request body for `POST`, `PUT`, `PATCH`\n  - Path parameters and query strings\n  - Response highlighting\n  - Response time and size display\n- Collection management (similar to Postman)\n- Output formatting (JSON / Table / Raw)\n\n## Author\n\nHyrapi by [@hwisnu222](https://github.com/hwisnu222)\n\nContributions and feedback are welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhwisnu222%2Fhyrapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhwisnu222%2Fhyrapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhwisnu222%2Fhyrapi/lists"}