{"id":18667756,"url":"https://github.com/temando/remark-openapi","last_synced_at":"2026-05-07T05:31:21.992Z","repository":{"id":57352994,"uuid":"100671775","full_name":"temando/remark-openapi","owner":"temando","description":"Remark plugin that converts a link to a local or remote OpenAPI spec into a table with summary of all paths","archived":false,"fork":false,"pushed_at":"2017-08-18T04:52:53.000Z","size":44,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-04-26T07:41:18.470Z","etag":null,"topics":["openapi","remark","remark-plugin"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/temando.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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-08-18T04:09:40.000Z","updated_at":"2020-04-15T01:36:25.000Z","dependencies_parsed_at":"2022-08-29T19:10:43.308Z","dependency_job_id":null,"html_url":"https://github.com/temando/remark-openapi","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/temando%2Fremark-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/temando%2Fremark-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/temando%2Fremark-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/temando%2Fremark-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/temando","download_url":"https://codeload.github.com/temando/remark-openapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239495472,"owners_count":19648329,"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":["openapi","remark","remark-plugin"],"created_at":"2024-11-07T08:39:57.147Z","updated_at":"2025-11-06T15:30:33.099Z","avatar_url":"https://github.com/temando.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# remark-openapi\n\n[![NPM](https://img.shields.io/npm/v/remark-openapi.svg)](https://npmjs.org/packages/remark-openapi/)\n[![Travis CI](https://img.shields.io/travis/temando/remark-openapi.svg)](https://travis-ci.org/temando/remark-openapi)\n[![MIT License](https://img.shields.io/github/license/temando/remark-openapi.svg)](https://en.wikipedia.org/wiki/MIT_License)\n\nA [remark](https://github.com/wooorm/remark) plugin that converts a link to a local or remote open api spec into a table with summary of all paths.\n\nThis project is inspired by [remark-swagger](https://github.com/yoshuawuyts/remark-swagger). It borrows some code in table generation from [remark-swagger](https://github.com/yoshuawuyts/remark-swagger).\n\n## Installation\n\n```sh\n$ npm install remark-openapi\n```\n\n## Usage\n\nThis plugin is to be used with [remark](https://github.com/wooorm/remark), e.g.\n\n```js\nvar vfile = require('to-vfile');\nvar remark = require('remark');\nvar openapi = require('remark-openapi');\n\nvar example = vfile.readSync('example.md');\n\nremark()\n  .use(openapi)\n  .process(example, function (err, file) {\n    if (err) throw err;\n\n    console.log(String(file));\n  });\n```\n\nThis plugin does a conversion when the markdown file contains a link to a local open api spec file\n\n```md\n[API Reference](../assets/petstore-open-api.json \"openapi:\")\n```\n\nor a remote open api spec file\n```md\n[API Reference](https://temando.github.io/open-api-renderer/petstore-open-api-v3.0.0-RC2.json \"openapi:\")\n```\n\nThe above will be converted to the following table:\n\n```md\n# swagger link\n| Path  | Method | Summary                    |\n| ----- | ------ | -------------------------- |\n| /pet  | POST   | Add a new pet to the store |\n| /pet  | PUT    | Update an existing pet     |\n| /user | POST   | Create user                |\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftemando%2Fremark-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftemando%2Fremark-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftemando%2Fremark-openapi/lists"}