Skimming API is a RESTful API that uses Skimming and Oak Middleware modules to deliver a simple and efficient search engine.

Request (GET) {{url}}/config 

Sample response

{ "message": "Success", "url": "https://raw.githubusercontent.com/petruki/skimming/master/", "files": [ "README.md" ], "cacheDuration": "60s", "cacheSize": 100 }

Request (GET) {{url}}/skim?query=Usage&previewLength=-1&ignoreCase=false&trimContent=true 

• query: value to search
• previewLength: ength of the content to be displayed
  • When 0: it display only the query value
  • When -1: it display the content until its first found line break
• ignoreCase: ignore case
• trimContent: prettify the content, basically
• regex: enable regular expression searching method
• skipCache: skip cache

Sample response

{ "message": "Success", "query": "Sk", "result": [ { "file": "README.md", "segment": [ "Skimming is a data fetcher for Deno. The idea is to provide a simple and efficient module to fetch content.", "Skimming from \"https://raw.githubusercontent.com/petruki/skimming/v1.0.0/mod.ts\";", "Skimming({ expireDuration: 10, size: 10 });" ], "found": 3, "cache": true } ] }

Request (GET) {{url}}/skim?url=https://deno.land/std/&files=manual.md 

• url: Endpoint to be fetched
• files: artifacts to be fetched

Please do open an issue or PR if you feel you have something cool to add.