{"id":26217038,"url":"https://github.com/asfand-dev/api-html","last_synced_at":"2025-10-20T00:30:05.532Z","repository":{"id":52188012,"uuid":"301224580","full_name":"asfand-dev/api-html","owner":"asfand-dev","description":"Convert any API Specification into an awesome HTML documentation website","archived":false,"fork":false,"pushed_at":"2021-04-18T16:12:27.000Z","size":6252,"stargazers_count":17,"open_issues_count":5,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-02T08:36:24.201Z","etag":null,"topics":["api","api-blueprint","api-html","documentation","google-api-descory","html","io-docs","openapi","raml","static-site","swagger","theme","wadl","website","yaml"],"latest_commit_sha":null,"homepage":"https://asfand-dev.github.io/api-html/","language":"JavaScript","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/asfand-dev.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}},"created_at":"2020-10-04T20:49:01.000Z","updated_at":"2024-12-04T12:45:08.000Z","dependencies_parsed_at":"2022-08-13T01:21:45.049Z","dependency_job_id":null,"html_url":"https://github.com/asfand-dev/api-html","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asfand-dev%2Fapi-html","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asfand-dev%2Fapi-html/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asfand-dev%2Fapi-html/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asfand-dev%2Fapi-html/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asfand-dev","download_url":"https://codeload.github.com/asfand-dev/api-html/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248661697,"owners_count":21141450,"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":["api","api-blueprint","api-html","documentation","google-api-descory","html","io-docs","openapi","raml","static-site","swagger","theme","wadl","website","yaml"],"created_at":"2025-03-12T12:18:41.340Z","updated_at":"2025-10-20T00:30:00.483Z","avatar_url":"https://github.com/asfand-dev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# API HTML\n\nConvert any API Specification into an awesome HTML documentation website\n\n![](https://raw.githubusercontent.com/asfand-dev/api-html/master/src/assets/img/apis.svg)\n\n# Screenshot\n![](https://cdn.jsdelivr.net/npm/api-html@1.0.1/assets/img/screenshot.png)\n\n\u003cbr /\u003e\u003cbr /\u003e\n\n## Use the online tool\n\n[API HTML](https://asfand-dev.github.io/api-html/)\n\n## Use CLI\n\n### Installation\n\n`npm i api-html -g`\n\n\u003cbr /\u003e\u003cbr /\u003e\n\n### Usage\n\n`api-html --url https://petstore.swagger.io/v2/swagger.json`\n\n[Demo](https://pets-shop-swagger.netlify.app/)\n\nThe above command will convert the given `url` into a static website in the current directory with the name of `dist` directory.\n\nThere is also a possibility to pass a `file` instead of `url`.\n\n### Params\n\n| Param | Short | Required | Default Value | Details |\n|---|---|---|---|---|\n|`--file`| `-f`  | `required` | null | Path to a local source file, `--file` or `--url` on is required at same time.\n|`--url`| `-u`  | `required` | null | URL to an online source file, `--file` or `--url` on is required at same time.\n|`--type`| `-t`  | optional | `swagger` | Encoded type of the API specification, like `swagger`, `openapi`, `api_blueprint`, `io_docs`, `google`, `raml` or `wadl`\n|`--version`| `-v`  | optional | `2` | Version of the OpenAPI (`swagger`), possible values are 1, 2 or 3. Only applicable to `swagger`\n|`--yaml`| `-y`  | optional | `0` | If the source file type is `yaml` then the value should be `1`, only applicable to `swagger`\n|`--option`| `-o`  | optional | `./options.json` | Path to the options file, see the details below\n\n### Example\n\n```\n  api-html --yaml 1 --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/yaml/api-with-examples.yaml\n  # A Swagger (OpenAPI) version 2 source file with yaml type\n\n  api-html --version 3 --url https://api.gettyimages.com/swagger/v3/swagger.json\n  # A Swagger (OpenAPI) version 3 source file with json type\n\n  api-html --version 3 --yaml 1 --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml\n  # A Swagger (OpenAPI) version 3 source file with yaml type\n\n  api-html --type api_blueprint --url https://raw.githubusercontent.com/apiaryio/api-blueprint/master/examples/Polls%20API.md\n  # An API Blueprint source file\n\n  api-html --type google --url https://www.googleapis.com/discovery/v1/apis/translate/v2/rest\n  # A Google API descory source file\n\n  api-html --type raml --url https://raw.githubusercontent.com/raml-apis/XKCD/master/api.raml\n  # A RAML source file\n\n  api-html --type io_docs --url https://raw.githubusercontent.com/lucybot/api-spec-converter/master/test/input/io_docs/foursquare.json\n  # An IO Docs source file\n```\n\u003cbr /\u003e\u003cbr /\u003e\u003cbr /\u003e\n\n### Options (options.json)\nThe options should be in a json file, If you don't pass the `--option` parameter then we will check in the current directory with the name of `options.json`.\n\n\n| Name | Default Value | Description |\n|---|---|---|\n|`theme`| `compact`  | Set the UI theme, values are: \"compact\" and \"basic\".\n|`baseColor`| `#6e9a04`  | Set the base color of the theme\n|`textColor`| `#FFF`  | Set the text color of the theme\n|`logo`| 'swagger-logo'  | Point a logo to a local file\n|`logoUrl`| ''  | Point a logo to the URL\n|`isCoding`| `true`  | Show or Hide the coding section in the request\n|`isSearch`| `true`  | Show or Hide the Search feature\n|`isTryRequest`| `true`  | Show or Hide the \"try out\" button in the request\n|`isBackToTopButton`| `true`  | Hide or show the `BackToTop` button\n|`isCreditLink`| `true`  | Hide or show the `Credit` link below the navigation bar\n|`pageTitle`| the  `title` from the `swagger.json` file  | Set the page title shown on browser title bar.\n|`customHeadScript`| ''  | Add custom script to the head tag\n|`customFootScript`| ''  | Add custom script to the foot tag\n|`pageTags`| ''  | Represent the meta keywords of the page, Each keyword should be seperated by a comma. Meta Keywords are helpful for the page SEO.\n|`pageDescription`| ''  | Represent the meta description of page\n|`apiVersions`| ''  | API Versions, enter in the following format:\u003cbr/\u003e(Name)[URL]\u003cbr/\u003e(Name)[URL]\u003cbr/\u003e...\u003cbr/\u003eExp:\u003cbr/\u003e(V1)[https://zamacall.io/docs/v1/]\u003cbr/\u003e(V2)[https://zamacall.io/docs/v2/]\n|`headerMenuItems`| ''  | Header Menu Items, enter in the following format:\u003cbr\u003e(Name)[URL]\u003cbr\u003e(Name)[URL]\u003cbr\u003e...\u003cbr\u003eExp:\u003cbr\u003e(Main Website)[https://zamacall.io]\u003cbr\u003e(Contact Us)[https://zamacall.io/contact/]\n\n\n\n#### Example\n\n```\n{\n  \"logo\": \"logo.svg\",\n  \"baseColor\": \"blue\"\n} \n```\n\n\n## Change log\n+ Added A new Compact UI Theme; Nice, Clean, Faster and lightweight.\n+ Added support for `IO Docs` source file\n+ Added support for `WADL` source file\n+ Added support for `RAML` source file\n+ Added support for `Google API Descory` source file\n+ Added support for `API Blueprint` source file\n+ Added support for `YAML` source file\n+ Added support for `OpenAPI `(swagger) version 1, 2, \u0026 3.\n+ Added the search functionality\n+ Added support for trying the api request\n+ Added support for code generation for languages like: `cURL`, `Node`, `Python` \u0026 `JavaScript`\n+ Added an online tool to preview and download through online website\n+ Added automatic description to the Authentication sections, will replace the empty descriptions.\n+ Added support for small screens like mobile devices\n\n\n## Report an issue or request a feature\n\n[Github issues](https://github.com/asfand-dev/api-html/issues)\n\n## Contact us\n\nasfand@gmail.com\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasfand-dev%2Fapi-html","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasfand-dev%2Fapi-html","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasfand-dev%2Fapi-html/lists"}