{"id":18633945,"url":"https://github.com/yanxi123-com/rest-api-doc","last_synced_at":"2025-11-04T09:30:43.602Z","repository":{"id":30106005,"uuid":"33655792","full_name":"yanxi123-com/rest-api-doc","owner":"yanxi123-com","description":"Define you api in coffee script, then generate the api document.","archived":false,"fork":false,"pushed_at":"2015-09-11T07:14:45.000Z","size":2220,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-06T01:42:39.697Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yanxi123-com.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":"2015-04-09T07:50:20.000Z","updated_at":"2024-12-03T09:16:03.000Z","dependencies_parsed_at":"2022-09-20T13:15:39.113Z","dependency_job_id":null,"html_url":"https://github.com/yanxi123-com/rest-api-doc","commit_stats":null,"previous_names":["yanxi-com/rest-api-doc","yanxi123-com/rest-api-doc"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yanxi123-com%2Frest-api-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yanxi123-com%2Frest-api-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yanxi123-com%2Frest-api-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yanxi123-com%2Frest-api-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yanxi123-com","download_url":"https://codeload.github.com/yanxi123-com/rest-api-doc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239195275,"owners_count":19598035,"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":[],"created_at":"2024-11-07T05:16:52.586Z","updated_at":"2025-11-04T09:30:43.561Z","avatar_url":"https://github.com/yanxi123-com.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"rest-api-doc\n=====================================\n\n### Put you API in api directory:\n[put your apis here](./api)\n\n### install\n```\nnpm install\nnpm install -g gulp\n```\n\n### Run dev\n```\ngulp dev\n```\n\n### deploy dev\n```\ngulp deploy-dev\n```\n\n### Run production\n```\ngulp prod\n```\n\n## api doc structure\n```coffee\nname: String\nbaseUrl: String\ndescription: String\napis: [{\n  title: String\n  description: String   # optional\n  url: String\n  method: String    # POST, GET\n\n  body: bodyStructure\n\n  successResponse: successResponseStructure\n\n  errorResponse: errorResponseStructure\n}]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyanxi123-com%2Frest-api-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyanxi123-com%2Frest-api-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyanxi123-com%2Frest-api-doc/lists"}