Hi Rasika,

your suggestions on .zip archive were accepted and changed the structure
accordingly.

Purpose of* FileContents* folder is to hold the corresponding file of a API
document with source type "FILE". "FILE" type documents are maintained
inside this folder to overcome the conflict that will arise at any case
between docs.json and  the document file, if a file named "docs.json"
uploaded as a *FILE* source typed document.

*InlineContents* folder is used to store API document content  with source
type "In-line".

And yes, this structure is valid for both REST and SOAP.

Regards,


On Tue, Jul 19, 2016 at 2:01 PM, Rasika Perera <[email protected]> wrote:

> Hi Kaveesha,
>
> Current import/export tool of APIM is based on APIM internal Java API
>> implementations for its functionality, Which been lead to tight coupling
>> between the code and  the API. This make restrictions on API maintenance
>> across versions and code changes.
>> Recently I'm working on modifying import/export tool to use APIM REST API
>> implementations to perform it's functionalities.This will add more dynamic
>> nature to APIs irrespective to the changes in code bases.
>> I'm completed with the first phase of the above by exporting a API using
>> REST APIs.
>
> +1 for allowing import/export capabilities through the REST-APIs.
>
> Few suggestions on the structure of the .zip archive;
>
> <APIName>-<version>
>    |-----meta-info                             <----- renamed : all in
> simple case would simplify case-sensitive problems
>    |       |---api.json
>    |       `--swagger.json
>    |-----docs                                    <----- renamed : all in
> simple case would simplify case-sensitive problems
>    |      |----FileContents                   <----- what'd be the
> purpose of this folder?
>    |      |----InlineContents                <----- what'd be purpose of
> this folder?
>    |      `---docs.json
>    |-----thumbnail.<extension>         <----- removed folder : since
> there's one image. renamed: thumbnail is more suitable IMO.
>    |-----sequences                           <----- renamed : all in
> simple case would simplify case-sensitive problems
>    |      |----fault-sequence
>    |      |----in-sequence
>    |      `----out-sequence
>    `-----<ApiName>-<version>.wsdl <----- removed folder : since there's
> only one wsdl
>
> Does above structure valid for both REST and SOAP?
>
> Thanks,
> Rasika
>
> --
> With Regards,
>
> *Rasika Perera*
> Software Engineer
> LinkedIn: http://lk.linkedin.com/in/rasika90
>
> [image: wso2-signature-general.png] <https://wso2.com/signature>
>
> WSO2 Inc. www.wso2.com
> lean.enterprise.middleware
>



-- 
Kaveesha Perera
Intern - Software Engineering

mobile: 0716130471
_______________________________________________
Architecture mailing list
[email protected]
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

Reply via email to