Case study in APIs

Đang mở
#322 3 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
20/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Lĩnh vực
api

Hướng nghiên cứu

The issue contains API request and response examples but names no repository file, test, or entry point to change. Start by locating the code that handles the shown post-creation response; done would require a maintainer-defined higher-level result that exposes the created post location and addresses the broader API concerns.

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

Mô tả

This is the info that my app sends to a server that then converts it to Bluesky's internal language as the arguments for a call that will create a new post. These are standard names for these things that any experience programmer would immediately recognize. Users would recognize them too, except perhaps urlsite.

{
    "title": "",
    "description": "Room for One More on Mount Rushmore?",
    "mailaddress": "",
    "password": "",
    "urlsite": "https://bsky.social/",
    "link": "https://politicalwire.com/2025/06/29/room-for-one-more-on-mount-rushmore/"
    }

And this is what comes back.

{
    "uri": "at://did:plc:zxb2lwpxo4axkkkgjwqand24/app.bsky.feed.post/3lsqtoowg2h2h",
    "cid": "bafyreifhet2772xmic24qr4xbui4l5lllvgek2a7kmmchojwwkufvzalci",
    "commit": {
        "cid": "bafyreicjjsd4ixlezubezaxzfaqxxpwlvoxdqwyxblnme5uh6ehklxth3a",
        "rev": "3lsqtoowpsx2h"
        },
    "validationStatus": "valid"
    }

Some of the terms mean something, like URI and commit, but their values don't mean anything to me, don't shed any light on what the result was except "validationStatus": "valid" seems to say "it worked." :-)

And nowhere in this package is the one piece of info every freaking app would need after posting something -- where the F did you put it!??

I don't have a problem with detailed internal info coming back from a query. I know APIs are used for lots of applications. But this is a problem I've seen repeatedly in their API, they push the work out to the developer where they for sure have the code internally to do it, and could factor out the work, instead of making us all implement what we're sure to need, do it once and provide a higher level interface.

Just some feedback for the Bluesky folk, and a caution when designing your own APIs, write some code that runs against your API, you'd see these problems right away.

Ngôn ngữ chính
HTML
Star
134
Fork
10
Chỉ số merge pull request
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 scripting/Scripting-News

Tất cả issue của scripting/Scripting-News

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.