UNPKG

very-express

Version:

based on json schema and openapi, generate Express RestApi server with mongoDb

44 lines (37 loc) 1.19 kB
# Foreign-key - Avalilable from v0.5.x - Api level collection joining ## Define Foreign-key Add attribute at JsonSchmea's field props, `x-foreignKey: "targetCollectionName"` Example: - **User Collection's** field "contactId" as foreign-key of **Contact Collection** ```JSON { "username": { "type" : "string", ... }, "contactId": { "type" : "string", "x-foreignKey" : "contact" } } ``` # REST API ## Parameters ### HTTP GET : | Param | Type | Mandatory | Description | | ----- | ---- | --------- | ----------- | | _join | QueryString `array<String>` | false | join collection using **Current Resource's Field Name**. target joined collection decleare by `x-forignKey` | | _select | QueryString `array<String>` | false | work with `_join`, select fields to join for target collection. empty = select all. | ## Example `/user?_join=["contact"]&_select=["contactName","contactNumber"]` **Output:** ```JSON { "username": "justin", "contactId": { "contactName": "justin's mobile", "contactNumber": 1122333445566 } }