api/pages/:projectname/search/query
プロジェクト内ページ全文検索
https://scrapbox.io/api/pages/:projectname/search/query
parameters
q
検索語句
で区切ると複数語句で検索できる
語句の先頭に-をつけるとマイナス検索できる
空白を含めて検索したいときは""で囲む
応答の型
code:ts
type SearchQueryResponse = {
projectName: string; // data取得先のproject名
searchQuery: string; // 検索語句
query: {
words: string[]; // AND検索に使った語句
excludes: string[]; // NOT検索に使った語句
};
limit: number; // 検索件数の上限
count: number; // 検索件数
existsExactTitleMatch: boolean; // 詳細不明
backend: 'elasticsearch';
pages: {
id: string;
title: string;
image: string; // 無いときは''になる
words: string[];
lines: string[]; //検索語句に一致した行。 タイトル行のみが一致した場合は、検索語句の有無にかかわらずその次の行のみが入る
}[];
}