Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

use 'OpenAPI link' to detect relations between entities

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

Hướng nghiên cứu

Trước tiên, hãy đọc phần relation-convention trong README và đặc tả OpenAPI Links được liên kết. Issue không nêu tệp triển khai, tiêu chí chấp nhận hay bài kiểm thử nào; hãy làm rõ Links phải cung cấp siêu dữ liệu quan hệ như thế nào và hành vi hiện có nào của convention cần được bao quát. Không thể xác minh việc hoàn tất cho đến khi phạm vi đó và các bài kiểm thử của nó được xác định.

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

Mô tả

Description
Why do you not use OpenAPI links to detect relations between entities instead of use the current conventions name based?

See:
https://github.com/api-platform/api-doc-parser/blob/895cd81e4208c8c70a7383f65cefc31f1706c353/README.md?plain=1#L57

In order to reference the resources between themselves (embeddeds or relations), the library guesses embeddeds or references from property names.
For instance if a book schema has a reviews property, the library tries to find a Review resource.
If there is, a relation or an embedded between Book and Review resources is made for the reviews field.
The property name can also be like review_id, reviewId, review_ids or reviewIds for references.

I'm discussing about this possibility on platformatic repository, here:
https://github.com/platformatic/platformatic/pull/446

Ngôn ngữ chính
TypeScript
Star
113
Fork
80
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 api-platform/api-doc-parser

Tất cả issue của api-platform/api-doc-parser

Issue tương tự

Thêm issue về TypeScript

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.