{"id":22822478,"url":"https://github.com/switcherapi/switcher-searchdocs","last_synced_at":"2025-03-30T23:41:39.494Z","repository":{"id":196284899,"uuid":"692894912","full_name":"switcherapi/switcher-searchdocs","owner":"switcherapi","description":"SearchDocs API powered by Deno, Oak and Skimming Module","archived":false,"fork":false,"pushed_at":"2025-03-08T21:17:44.000Z","size":149,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-08T22:21:02.276Z","etag":null,"topics":["deno","oak","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/switcherapi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2023-09-17T22:41:50.000Z","updated_at":"2025-03-08T21:17:47.000Z","dependencies_parsed_at":"2023-12-17T22:22:40.273Z","dependency_job_id":"f12ac43b-11bf-4968-a284-d78fc527ecfa","html_url":"https://github.com/switcherapi/switcher-searchdocs","commit_stats":null,"previous_names":["switcherapi/switcher-searchdocs"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/switcherapi%2Fswitcher-searchdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/switcherapi%2Fswitcher-searchdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/switcherapi%2Fswitcher-searchdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/switcherapi%2Fswitcher-searchdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/switcherapi","download_url":"https://codeload.github.com/switcherapi/switcher-searchdocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246395573,"owners_count":20770240,"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","oak","skimming"],"created_at":"2024-12-12T16:12:05.599Z","updated_at":"2025-03-30T23:41:39.473Z","avatar_url":"https://github.com/switcherapi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"***\n\n\u003cdiv align=\"center\"\u003e\n\u003cb\u003eSwitcher SearchDocs API\u003c/b\u003e\u003cbr\u003e\nA remote document search engine that uses Skimming for Deno\u003cbr\u003e\u003cbr\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![Master CI](https://github.com/switcherapi/switcher-searchdocs/actions/workflows/master.yml/badge.svg)](https://github.com/switcherapi/switcher-searchdocs/actions/workflows/master.yml)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=switcherapi_switcher-searchdocs\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=switcherapi_switcher-searchdocs)\n[![Docker Hub](https://img.shields.io/docker/pulls/trackerforce/switcher-searchdocs.svg)](https://hub.docker.com/r/trackerforce/switcher-searchdocs)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Slack: Switcher-HQ](https://img.shields.io/badge/slack-@switcher/hq-blue.svg?logo=slack)](https://switcher-hq.slack.com/)\n\n\u003c/div\u003e\n\n***\n\n# About\n\nSwitcher SearchDocs API 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## Running locally\n\n1. Clone the repository\n2. Run `deno task run:dev` or test with `deno task test`\n3. Happy Deno hacking with SearchDocs!\n\n## Usage\n\n### Lockup API info\n```\nRequest (GET)\n{{url}}/api/check\n```\n**Sample response**\n```json\n{\n    \"status\": \"ok\",\n    \"releaseTime\": \"today\",\n    \"sslEnabled\": false,\n    \"appSettings\": {\n        \"url\": \"https://raw.githubusercontent.com/petruki/skimming/master/\",\n        \"files\": \"README.md\",\n        \"cacheExpDuration\": \"5\",\n        \"cacheSize\": \"100\"\n    }\n}\n```\n\n### From local content\n```\nRequest (GET)\n{{url}}/?query=Usage\u0026previewLength=-1\u0026ignoreCase=false\u0026trimContent=true\n```\n - query: value to search\n - previewLength: length of the content to be returned\n   - When 0: it shows only the matched word\n   - When -1: it shows the entire content from the first match\n - ignoreCase: ignore case\n - trimContent: prettify the response segment, 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### From remote content\n```\nRequest (GET)\n{{url}}/?url=https://raw.githubusercontent.com/denoland/deno/main/\u0026files=README.md\n```\n - url: Endpoint to be fetched\n - files: artifacts to be fetched\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswitcherapi%2Fswitcher-searchdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswitcherapi%2Fswitcher-searchdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswitcherapi%2Fswitcher-searchdocs/lists"}