Standalone API editor Current situation and problems
If we want to edit an API project, we have to open the artefacts of the API project and do the modification using an editor( like VSCode, etc.). But, there are some difficulties in this approach. 1. It is not a very user-friendly way because files need to be edited manually 2. The person who wants to edit the project should have a better understanding of many things such as standards and specifications of defining APIs, custom vendor extensions, etc. 3. Sometimes there can be thousands of lines of codes should be reviewed and edited 4. Cannot validate the modification( validating - check whether the modification violates standards, structure, and architecture) A standalone API editor can be a handy tool for eliminating these difficulties. Identified use cases - API manager users who use dev first approach want to edit APIs using a standalone API editor - Micro gateway users want to use API editor to edit an API easily Identified benefits - Get more dev first users into API CTL by promoting this API editor - Provide an API editor to micro gateway users and it can eliminate the risk of violating the API definition structure. Proposed Solutions Proposal Pros Cons Make a VSCode plugin Maintainability Standalone editor with an API layer Reusability Make an editor on top of the publisher UI as a profile of API manager Reusability Extending the new registry implementation( file system can be used instead of MongoDB) Maintainability Use the import and export method with extensible UI Maintainability Reusability Startup time is high Application size is high My selection among Proposed Solutions - Reuse the components of publisher portal and Make implementation to the API layer using swagger Your feedback on the above-stated selection will be much appreciated before starting the implementation. -- Thisal Tennakoon | Intern-Engineering (M) +94 766 220 249 (E) thi...@wso2.com http://wso2.com/signature
_______________________________________________ Architecture mailing list Architecture@wso2.org https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
