I have been referring to the document and have some queries listed below:
- In API specification we are using the field such as @type, @baseType, @SchmemaLocation, @referredType
- Should we be using @ as a naming convention for the json fields?
- Above mentioned fields are used to define the different class types, so is it advisable to use Class types or yml in response?
- href is used for referencing purpose so if a response contains the information from third service then should we use href to point to that url?
- Like: ProductCatalog has relatedParty fields which is coming for party service in this case should we have the href for partyManagement APIs. (ref: Json representation sample: page 12 )
Please suggest and help to solve above queries.
------------------------------
Gaurav Sharma
Tech Mahindra Limited
------------------------------