Open APIs

Expand all | Collapse all

API implmentation roadmap

  • 1.  API implmentation roadmap

    TM Forum Member
    Posted 10 days ago
    ​​​Hi all,
    I would like to ask if this operational plan to define an API contract is correct or I need to add more phases. Specifically:
    1) Business Data Selection
    2) Definition of API structure, methods and resources
    3) Definition of API Contract
    4) Validation of API contract by Customer
    Thanks in advance for your fedbacks,
    Filippo



    ------------------------------
    Filippo Roberto Valeriani
    NTT DATA CORPORATION
    ------------------------------


  • 2.  RE: API implmentation roadmap

    TM Forum Member
    Posted 10 days ago
    Hi Filippo
    I think it starts before that:
    • Define the business problem and domain you are trying to solve
    • Create business use cases and illustrate the flows by sequence diagrams - this will give you the business operations that you need
    • Define the entity(ies) taking part in the flows, with attributes
    • Define the API structure (if you are using REST, like TMF Open APIs, you are limited in operations to the REST verbs, so you may need Task entities)
    • Document the entities and attributes
    • Create examples
    • Create (or generate) the technical contract (for REST it could be a Swagger or OAS 3.x format)
    • Validate design by customer
    Maybe there are more steps
    Hope it helps

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 3.  RE: API implmentation roadmap

    TM Forum Member
    Posted 8 days ago
    Thanks for your reply Jonathan. It is very helpful .
    Filippo             ​

    ------------------------------
    Filippo Roberto Valeriani
    NTT DATA CORPORATION
    ------------------------------