Api documentation as json or interactively?

Đang mở
#11 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
json, openapi
Lĩnh vực
api, documentation

Hướng nghiên cứu

Bắt đầu với tài liệu API được liên kết và tài liệu về việc tạo JSON của TypeDoc; so sánh endpoint .json được đề xuất với phương án thay thế Swagger/OpenAPI. Công việc được xem là hoàn tất khi có một phương án được lập tài liệu và thống nhất để cung cấp các module và method dưới dạng máy có thể đọc được.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

I checked out the api documentation and couldn't find a way to get the modules and methods in a machine readable way. However typedoc 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, which is for OpenApi-documented RESTful apis only. But maybe there exists something comparable for typedoc?!

Ngôn ngữ chính
HTML
Star
26
Fork
8
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của logseq/plugins

Tất cả issue của logseq/plugins

Issue tương tự

Thêm issue về Backend & API Design

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.