logseq / logseq/plugins

Api documentation as json or interactively?

オープン
#11 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
HTML
スター
26
フォーク
8
PR マージ指標
30日以内にマージされた PR はありません

説明

I checked out the [api documentation](https://plugins-doc.logseq.com/) and couldn't find a way to get the modules and methods in a machine readable way. However [typedoc](https://typedoc.org/) states that you can generate json from the comments.

Could we add json somehow, maybe for something like

```
https://plugins-doc.logseq.com/logseq/baseInfo
```

it could just be:

```
https://plugins-doc.logseq.com/logseq/baseInfo.json
```

An alternative could be something like [swagger](https://swagger.io/), which is for OpenApi-documented RESTful apis only. But maybe there exists something comparable for typedoc?!

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

リンクされた API ドキュメントと、TypeDoc の JSON 生成に関するドキュメントから始め、提案されている .json エンドポイントを Swagger/OpenAPI の代替案と比較します。完了条件は、モジュールとメソッドを機械可読な形式で公開するための、文書化され合意されたアプローチが確立されていることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
json, openapi
領域
api, documentation
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。