{"id":20779617,"url":"https://github.com/smartlogic/radex","last_synced_at":"2025-08-07T21:33:40.127Z","repository":{"id":57539276,"uuid":"105930741","full_name":"smartlogic/radex","owner":"smartlogic","description":"Generate API Documentation through ExUnit","archived":false,"fork":false,"pushed_at":"2017-10-12T17:13:07.000Z","size":42,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-07-29T00:47:51.628Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Elixir","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/smartlogic.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":"2017-10-05T19:20:30.000Z","updated_at":"2019-05-14T21:28:09.000Z","dependencies_parsed_at":"2022-09-21T06:02:57.266Z","dependency_job_id":null,"html_url":"https://github.com/smartlogic/radex","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/smartlogic/radex","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartlogic%2Fradex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartlogic%2Fradex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartlogic%2Fradex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartlogic%2Fradex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smartlogic","download_url":"https://codeload.github.com/smartlogic/radex/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartlogic%2Fradex/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269330440,"owners_count":24399115,"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","status":"online","status_checked_at":"2025-08-07T02:00:09.698Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":"2024-11-17T13:28:57.642Z","updated_at":"2025-08-07T21:33:40.093Z","avatar_url":"https://github.com/smartlogic.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Radex\n\n[![Build Status](https://travis-ci.org/smartlogic/radex.svg?branch=master)](https://travis-ci.org/smartlogic/radex)\n\nA utility to generate documentation for your web API via tests.\n\n## Installation\n\n```elixir\n# mix.exs\n\ndefp deps do\n  [\n    {:radex, \"~\u003e 0.1.0\", only: :test},\n  ]\nend\n\n# You can also set up an alias for the formatter\n# This must be run with MIX_ENV=test explicitly declared\ndefp aliases do\n  [\n    \"radex.test\": [\"test --formatter Radex.Formatter\"],\n  ]\nend\n```\n\n## Usage\n\nAn example test:\n\n```elixir\ndefmodule AppWeb.OrderControllerTest do\n  use AppWeb.ConnCase\n\n  describe \"creating\" do\n    use Radex.Endpoint\n\n    @resource \"Orders\"\n    @route {\"POST\", \"/orders\"}\n\n    @parameter {\"location\", \"Order Location\", type: :string}\n\n    test \"Creating an Order\", %{conn: conn} do\n      conn =\n        conn\n        |\u003e post(order_path(conn, :create), %{name: \"Cafe\"})\n        |\u003e record()\n\n      assert conn.status == 201\n    end\n  end\nend\n```\n\nRecord documentation by using the Radex formatter:\n\n```\nmix test --formatter Radex.Formatter\nMIX_ENV=test mix radex.test\n```\n\n## Configuration\n\n```elixir\n# config/test.exs\n\nconfig :radex,\n  path: \"docs\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartlogic%2Fradex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmartlogic%2Fradex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartlogic%2Fradex/lists"}