{"id":21194756,"url":"https://github.com/advanced-rest-client/api-summary","last_synced_at":"2026-01-08T21:14:58.433Z","repository":{"id":32459007,"uuid":"129469587","full_name":"advanced-rest-client/api-summary","owner":"advanced-rest-client","description":"⛔️ DEPRECATED This component is being deprecated. Use `api-documentation` instead.","archived":false,"fork":false,"pushed_at":"2024-05-09T19:53:34.000Z","size":7191,"stargazers_count":0,"open_issues_count":12,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-11T01:53:55.216Z","etag":null,"topics":["deprecated","obsolete"],"latest_commit_sha":null,"homepage":"","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/advanced-rest-client.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}},"created_at":"2018-04-14T01:20:09.000Z","updated_at":"2024-05-09T19:50:54.000Z","dependencies_parsed_at":"2024-04-24T21:44:56.342Z","dependency_job_id":null,"html_url":"https://github.com/advanced-rest-client/api-summary","commit_stats":{"total_commits":123,"total_committers":6,"mean_commits":20.5,"dds":"0.34959349593495936","last_synced_commit":"2b5e3bfeb55c56af5a474c1433dc7c4ae94be84c"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"purl":"pkg:github/advanced-rest-client/api-summary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/advanced-rest-client%2Fapi-summary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/advanced-rest-client%2Fapi-summary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/advanced-rest-client%2Fapi-summary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/advanced-rest-client%2Fapi-summary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/advanced-rest-client","download_url":"https://codeload.github.com/advanced-rest-client/api-summary/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/advanced-rest-client%2Fapi-summary/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264522472,"owners_count":23622363,"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":["deprecated","obsolete"],"created_at":"2024-11-20T19:24:15.866Z","updated_at":"2026-01-08T21:14:58.350Z","avatar_url":"https://github.com/advanced-rest-client.png","language":"JavaScript","readme":"# DEPRECATED\n\nThis component is being deprecated. The code base has been moved to [api-documentation](https://github.com/advanced-rest-client/api-documentation) module. This module will be archived when [PR 37](https://github.com/advanced-rest-client/api-documentation/pull/37) is merged.\n\n-----\n\nA component that renders basic information about an API.\nIt uses AMF model to render the view.\n\n[![Published on NPM](https://img.shields.io/npm/v/@api-components/api-summary.svg)](https://www.npmjs.com/package/@api-components/api-summary)\n\n[![Tests and publishing](https://github.com/advanced-rest-client/api-summary/actions/workflows/deployment.yml/badge.svg)](https://github.com/advanced-rest-client/api-summary/actions/workflows/deployment.yml)\n\n## Version compatibility\n\nThis version only works with AMF model version 2 (AMF parser \u003e= 4.0.0).\nFor compatibility with previous model version use `3.x.x` version of the component.\n\n## Usage\n\n### Installation\n\n```sh\nnpm install --save @api-components/api-summary\n```\n\n### In an html file\n\n```html\n\u003chtml\u003e\n  \u003chead\u003e\n    \u003cscript type=\"module\"\u003e\n      import '@api-components/api-summary/api-summary.js';\n    \u003c/script\u003e\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003capi-summary\u003e\u003c/api-summary\u003e\n    \u003cscript\u003e\n    const amf = await getAmfModel();\n    document.body.querySelector('api-summary').api = amf;\n    window.addEventListener('api-navigation-selection-changed', (e) =\u003e {\n      console.log(e.detail.selected);\n      console.log(e.detail.type);\n    });\n    \u003c/script\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\n### Styling using CSS Shadow Parts\n\n```html\n\u003chtml\u003e\n  \u003chead\u003e\n    \u003cscript type=\"module\"\u003e\n      import '@api-components/api-summary/api-summary.js';\n    \u003c/script\u003e\n    \u003cstyle type=\"text/css\"\u003e\n      api-summary::part(api-title) {\n        font-size: 24px;\n      }\n    \u003c/style\u003e\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003capi-summary exportparts=\"api-title\"\u003e\u003c/api-summary\u003e\n    \u003cscript\u003e\n    const amf = await getAmfModel();\n    document.body.querySelector('api-summary').api = amf;\n    window.addEventListener('api-navigation-selection-changed', (e) =\u003e {\n      console.log(e.detail.selected);\n      console.log(e.detail.type);\n    });\n    \u003c/script\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\nFor a complete list of parts, check out this [doc](./Styling.md).\n\n### In a LitElement template\n\n```js\nimport { LitElement, html } from 'lit-element';\nimport '@api-components/api-summary/api-summary.js';\n\nclass SampleElement extends LitElement {\n  render() {\n    return html`\n    \u003capi-summary .api=\"${this._amfModel}\" @api-navigation-selection-changed=\"${this._navHandler}\"\u003e\u003c/api-summary\u003e\n    `;\n  }\n\n  _navHandler(e) {\n    console.log(e.detail.selected);\n    console.log(e.detail.type);\n  }\n}\ncustomElements.define('sample-element', SampleElement);\n```\n\n### In a Polymer 3 element\n\n```js\nimport {PolymerElement, html} from '@polymer/polymer';\nimport '@api-components/api-summary/api-summary.js';\n\nclass SampleElement extends PolymerElement {\n  static get template() {\n    return html`\n    \u003capi-summary api=\"[[amfModel]]\" on-api-navigation-selection-changed=\"_navHandler\"\u003e\u003c/api-summary\u003e\n    `;\n  }\n\n  _navHandler(e) {\n    console.log(e.detail.selected);\n    console.log(e.detail.type);\n  }\n}\ncustomElements.define('sample-element', SampleElement);\n```\n\n## Development\n\n```sh\ngit clone https://github.com/advanced-rest-client/api-summary\ncd api-summary\nnpm install\n```\n\n### Running the demo locally\n\n```sh\nnpm start\n```\n\n### Running the tests\n\n```sh\nnpm test\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadvanced-rest-client%2Fapi-summary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadvanced-rest-client%2Fapi-summary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadvanced-rest-client%2Fapi-summary/lists"}