{"id":25045143,"url":"https://github.com/petruki/skimming-api","last_synced_at":"2026-05-02T03:33:38.698Z","repository":{"id":41483382,"uuid":"259514415","full_name":"petruki/skimming-api","owner":"petruki","description":"Skimming API is a RESTful API that uses Skimming and Oak Middleware modules to deliver a simple and efficient search engine.","archived":false,"fork":false,"pushed_at":"2023-07-14T02:35:41.000Z","size":54,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-06T05:34:58.625Z","etag":null,"topics":["deno","search-engine","skimming"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/petruki.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-28T02:51:15.000Z","updated_at":"2022-07-02T18:54:34.000Z","dependencies_parsed_at":"2025-02-06T05:32:48.556Z","dependency_job_id":"ff1e68c4-ab54-4ac8-8e3f-1f2632f11b86","html_url":"https://github.com/petruki/skimming-api","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petruki%2Fskimming-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petruki%2Fskimming-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petruki%2Fskimming-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petruki%2Fskimming-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/petruki","download_url":"https://codeload.github.com/petruki/skimming-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246399106,"owners_count":20770861,"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":["deno","search-engine","skimming"],"created_at":"2025-02-06T05:32:39.499Z","updated_at":"2026-05-02T03:33:38.519Z","avatar_url":"https://github.com/petruki.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Master CI](https://github.com/petruki/skimming-api/actions/workflows/master.yml/badge.svg)](https://github.com/petruki/skimming-api/actions/workflows/master.yml)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n# `Skimming API `\n\nSkimming API is a RESTful API that uses [Skimming](https://github.com/petruki/skimming) and [Oak Middleware](https://github.com/oakserver/oak) modules to deliver a simple and efficient search engine.\n\n## Usage\n\n### Lockup API info\n```\nRequest (GET)\n{{url}}/config\n```\n**Sample response**\n```json\n{\n    \"message\": \"Success\",\n    \"url\": \"https://raw.githubusercontent.com/petruki/skimming/master/\",\n    \"files\": [\n        \"README.md\"\n    ],\n    \"cacheDuration\": \"60s\",\n    \"cacheSize\": 100\n}\n```\n\n### Invoking API - Local configuration\n```\nRequest (GET)\n{{url}}/skim?query=Usage\u0026previewLength=-1\u0026ignoreCase=false\u0026trimContent=true\n```\n - query: value to search\n - previewLength: ength of the content to be displayed\n   - When 0: it display only the query value\n   - When -1: it display the content until its first found line break\n - ignoreCase: ignore case\n - trimContent: prettify the content, basically\n - regex: enable regular expression searching method\n - skipCache: skip cache\n \n**Sample response**\n```json\n{\n    \"message\": \"Success\",\n    \"query\": \"Sk\",\n    \"result\": [\n        {\n            \"file\": \"README.md\",\n            \"segment\": [\n                \"Skimming is a data fetcher for Deno. The idea is to provide a simple and efficient module to fetch content.\",\n                \"Skimming from \\\"https://raw.githubusercontent.com/petruki/skimming/v1.0.0/mod.ts\\\";\",\n                \"Skimming({ expireDuration: 10, size: 10 });\"\n            ],\n            \"found\": 3,\n            \"cache\": true\n        }\n    ]\n}\n```\n\n### Invoking API - External content\n```\nRequest (GET)\n{{url}}/skim?url=https://deno.land/std/\u0026files=manual.md\n```\n - url: Endpoint to be fetched\n - files: artifacts to be fetched\n\n## Contributing\nPlease do open an issue or PR if you feel you have something cool to add.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpetruki%2Fskimming-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpetruki%2Fskimming-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpetruki%2Fskimming-api/lists"}