PromoStandards Hackathon: Putting Soap To Rest Presentation

Insights from the video:

📱 REST is easier to adapt for client-side applications like web and mobile apps, and the developer community is adopting the rest standard at a much higher rate than SOAP.

🌐 The project primarily utilizes a.net core project as a reliable web-based framework for its ease of implementation and integration with other tools.

📚 The usage of Swagger simplifies the management of API documentation by automatically updating the documentation when the specification changes, making maintenance easier.

🔄 Restructuring endpoints can involve combining similar data into a single endpoint, with the differentiation being in the query parameters used to filter the response, resulting in a more cohesive and simplified API design.

🚀 The alternative UI for specification inquiries is designed to be simpler and more efficient, allowing users to easily access API calls, tweak them, and view the schema and data in a user-friendly grid with familiar features like search and sorting.

🌐 The use of a universally viewed and accepted code set is seen as a single point of truth for ERP developers, highlighting the significance of standardization in the industry.

💡 It's interesting to note that even if the data is grabbed from different services, everything is a sub resource of products.

💬 There are strong opinions on soap, suggesting that there may be differing viewpoints or arguments regarding its effectiveness or necessity.

Summary

The key idea of the video is that REST is proposed as a better alternative to the SOAP protocol for promo standards, offering benefits such as lightweight communication, reduced network traffic, and easier adaptability for client-side applications.

💡 00:00 Rest is proposed as a better alternative to the soap protocol for promo standards, offering benefits such as lightweight communication, reduced network traffic, and easier adaptability for client-side applications.

• The speaker proposes reintroducing promo standards without the soap protocol as a solution to the issue of Json data.
• REST is a more practical and preferred option for communication due to its lightweight nature, smaller character footprint, reduced network traffic, and easier adaptability for client-side applications, despite some partners' reluctance to adopt the standard.

📝 01:55 An open source community used a.net core project to improve participation and innovation in the PromoStandards Hackathon, implementing c-sharp classes, Swagger library for API documentation, and basic HTTP authentication for security.

• An open source community guided solution using a.net core project was implemented for better participation and innovation in the PromoStandards Hackathon.
• The speaker discusses the process of generating c-sharp classes from whistles provided by Starline, tweaking the schema code to add qualitative data, using a Swagger library to generate API documentation, restructuring the data to adhere to rest principles, and implementing basic HTTP authentication for security.

📝 03:42 The speaker discusses the addition of request payload, validator tool, alternative UI, and simple product viewer to assist with the review and implementation of res promo standards, emphasizing the use of Swagger for maintaining and documenting API endpoints and the importance of grouping endpoints by resources and descriptive URLs.

• The speaker discusses the request payload, a validator tool, an alternative UI, and a simple product viewer that have been added to assist with the review and implementation of the res promo standards.
• Swagger is a tool that uses code as the definition of a standard, making it easier to maintain and document API endpoints and their expected data types and responses.
• HTTP codes such as 200 for Success and 204 for no content, Swagger UI can be used to test endpoints, and the main takeaway is that endpoints should be grouped by resources and their URLs should describe the data they return.

📝 06:50 Consolidating existing endpoints and implementing query parameters can simplify API structure and reduce the number of endpoints needed.

🔧 08:30 Restructure product information into three endpoints and include a validator tool that fetches and validates results, providing a user-friendly UI for specification inquiries.

• Restructure product information into three different endpoints and include a validator tool in the solution scope.
• The tool fetches and validates results, comparing them to the official schema and listing any non-compliant differences, providing a simpler and more user-friendly alternative UI for specification inquiries with familiar features such as search and sorting.

🔑 10:19 Integrating data from product inventory and media APIs using REST APIs is easy and beneficial, as it provides a universally accepted code set for continuous improvement, and an open source implementation with Majestic Json outputs is available for others to use and discuss.

• The speaker demonstrates how easy it is to integrate data from product inventory and media APIs using REST APIs, highlighting the benefits of using a code set that is universally viewed and accepted as a single point of truth for continuous improvement in the future.
• Our solution includes an open source implementation with Majestic Json outputs, allowing anyone to clone the GitHub project and use it as a starting point for their own implementation, eliminating the need for rewriting the wheel and encouraging discussion for change.

💡 12:20 The speaker explains how they recreated most promo standard services as a REST service, with product data as the main resource, and mentions that additional fields can be added to the request or response without causing issues.

🧼 14:02 There is pressure to put soap to rest, with strong opinions and live demos being shared in the chat.