Layer7 API Management

  • 1.  API PORTAL - how can I do to document the following?

    Posted 07-13-2017 03:11 PM

    I want to document "IMPLEMENTATION NOTES" I also want to include "fixed PARAMETERS" and also include a "JSON" in "{required}"

     

    Can you help me?



  • 2.  Re: API PORTAL - how can I do to document the following?
    Best Answer

    Posted 07-14-2017 08:07 AM

    Hi,

     

    If you are using a WADL  include the below fields highlighted in Bold. It should populate the contents when the document gets generated.

           

            <method name="POST" id="postdata">
                <doc xml:lang="en" title="postdata">Implemntation notes for the post data</doc>
              <request>
               <doc xml:lang="en">This data gets poppulated as "Description" on right side of text block</doc>
       <representation mediaType="application/json">
        <doc title="payload">
         { "name":"John", "age":30, "cars":[ "Ford", "BMW", "Fiat" ] }
        </doc>
       </representation>
              </request>
              <response status="200">
                <representation mediaType="application/json"/>
              </response>
            </method>
          </resource>



  • 3.  Re: API PORTAL - how can I do to document the following?

    Posted 07-14-2017 01:53 PM

    Suhas

    Thank you very much for your prompt reply.

     

    I tried it and it worked correctly.

     

    I still do not find the "tag" referred to "implementation notes", the only way I found was to modify that structure was by editing the page http: // ip: port / staging / documentation / apix ... in xml format (source)



  • 4.  Re: API PORTAL - how can I do to document the following?

    Posted 11-06-2017 09:58 AM

    Hi Sushas, 

    How I do this?

    I want to insert  '\n' at a <doc xml:lang="en" title="postdata">Implemntation notes \n for the post data</doc>

    I want to show this:

    Implementation notes

    for the post data

     

    Thank you in advance.

    Best regards