Apparatus and method for structuring a resource of an application programming interface
A system and method of the disclosure relates to structuring at least one resource of an application programming interface (API) for a server. In the method, a plurality of field-level elements may be defined. Each of the plurality of field-level elements may be associated with a respective property. Also, first and second message-level elements may be defined. The first message-level element may be based on a first field-level element of the plurality of field-level elements, and the second message-level element may be based on the first field-level element. The API may be associated with a first resource having properties resolved based on at least the first and second message-level elements.
1. A method for transmitting information via an application programming interface (API) at an onboard server onboard an aircraft, comprising:
storing, at the onboard server onboard the aircraft, a hierarchy of elements comprising:
a plurality of field-level elements including a first field-level element and a second field-level element;
a first intermediate-level element based on the first field-level element; and
a first message-level element based on the first intermediate-level element and the second field-level element;
receiving a first request for aircraft information from a ground server external to the aircraft, the first request including a first resource associated with the first message-level element; and
in response to receiving the first request, transmitting, to the ground server via the API at the onboard server, a first response including one or more of the first field-level element, the second field-level element, and the first message-level element.
2. The method of claim 1 , wherein the first response includes the first field-level element, the second field-level element, and the first message-level element.
3. The method of claim 1 , wherein the first intermediate-level element is further based on a third field-level element.
4. The method of claim 1 , wherein the hierarchy of elements further comprises a second intermediate-level element, and wherein the second intermediate-level element differs from the first intermediate-level element by at least one field-level element.
5. The method of claim 4 , wherein the first message-level element is further based on the second intermediate-level element.
6. The method of claim 1 , wherein the first resource comprises an endpoint of the API.
7. The method of claim 1 , wherein each property associated with a field-level element comprises a name-value pair.
8. The method of claim 1 , wherein the first field-level element comprises a vehicle identifier.
9. An apparatus for transmitting information via an application programming interface (API) at an onboard server onboard an aircraft, comprising:
a hardware processor configured to:
store, at the onboard server onboard the aircraft, a hierarchy of elements comprising:
a plurality of field-level elements including a first field-level element and a second field-level element;
a first intermediate-level element based on the first field-level element; and
a first message-level element based on the first intermediate-level element and the second field-level element;
receive a first request for aircraft information from a ground server external to the aircraft, the first request including a first resource associated with the first message-level element; and
in response to receiving the first request, transmit, to the ground server via the API at the onboard server, a first response including one or more of the first field-level element, the second field-level element, and the first message-level element.
10. The apparatus of claim 9 , wherein the first response includes the first field-level element, the second field-level element, and the first message-level element.
11. The apparatus of claim 9 , wherein the first intermediate-level element is further based on a third field-level element.
12. The apparatus of claim 9 , wherein the hierarchy of elements further comprises a second intermediate-level element, and wherein the second intermediate-level element differs from the first intermediate-level element by at least one field-level element.
13. The apparatus of claim 12 , wherein the first message-level element is further based on the second intermediate-level element.
14. The apparatus of claim 9 , wherein the first resource comprises an endpoint of the API.
15. The apparatus of claim 9 , wherein each property associated with a field-level element comprises a name-value pair.
16. The apparatus of claim 9 , wherein the first field-level element comprises a vehicle identifier.
17. A non-transitory computer-readable medium onboard an aircraft, comprising:
code for causing a computer onboard an aircraft to store a hierarchy of elements comprising:
a plurality of field-level elements including a first field-level element and a second field-level element;
a first intermediate-level element based on the first field-level element; and
a first message-level element based on the first intermediate-level element and the second field-level element;
code for causing the computer to receive a first request for aircraft information from a ground server external to the aircraft, the first request including a first resource associated with the first message-level element; and
code for causing the computer to transmit to the ground server via an application programming interface (API) at the computer, in response to receiving the first request, a first response including one or more of the first field-level element, the second field-level element, and the first message-level element.
18. The non-transitory computer-readable medium of claim 17 , wherein the first response includes the first field-level element, the second field-level element, and the first message-level element.
19. The non-transitory computer-readable medium of claim 17 , wherein the first intermediate-level element is further based on a third field-level element.
20. The non-transitory computer-readable medium of claim 17 , wherein the hierarchy of elements further comprises a second intermediate-level element, and wherein the second intermediate-level element differs from the first intermediate-level element by at least one field-level element.