"use strict"; const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; function _createMdxContent(props) { const _components = { a: "a", code: "code", div: "div", h2: "h2", h3: "h3", img: "img", li: "li", ol: "ol", p: "p", path: "path", pre: "pre", span: "span", strong: "strong", svg: "svg", table: "table", tbody: "tbody", td: "td", th: "th", thead: "thead", tr: "tr", ul: "ul", ..._provideComponents(), ...props.components }; return _jsxs(_Fragment, { children: [_jsxs(_components.p, { children: [_jsx(_components.a, { href: "/tags/Technology", className: "tag-pill", "data-tag": "Technology", children: "#Technology" }), " ", _jsx(_components.a, { href: "/tags/definition", className: "tag-pill", "data-tag": "definition", children: "#definition" }), "\nSOAP vs REST vs JSON are comparisons that are frequently made in discussions about web services. While SOAP and REST are both leading approaches to transferring data over a network using API calls, JSON is a compact data format that RESTful web services can use."] }), "\n", _jsx(_components.p, { children: "Deciding whether you should create a SOAP vs REST API is an essential question if you are planning to provide a web service. Each architectural style has its own use cases, benefits, and limitations. In this article, we’ll look into both the SOAP protocol and the REST guidelines in detail and also see how JSON fits into the landscape." }), "\n", _jsx(_components.p, { children: "Here are our quick links if you want to jump ahead:" }), "\n", _jsxs(_components.ol, { children: ["\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://raygun.com/blog/soap-vs-rest-vs-json/#webservices", target: "_blank", rel: "noopener noreferrer", children: "What are web services?" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://raygun.com/blog/soap-vs-rest-vs-json/#differences", target: "_blank", rel: "noopener noreferrer", children: "The main differences between SOAP and REST" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://raygun.com/blog/soap-vs-rest-vs-json/#stand", target: "_blank", rel: "noopener noreferrer", children: "What does REST stand for?" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://raygun.com/blog/soap-vs-rest-vs-json/#reasonrest", target: "_blank", rel: "noopener noreferrer", children: "What’s the main reason to use REST?" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://raygun.com/blog/soap-vs-rest-vs-json/#challengesrest", target: "_blank", rel: "noopener noreferrer", children: "Challenges/limitations in REST" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://raygun.com/blog/soap-vs-rest-vs-json/#restjson", target: "_blank", rel: "noopener noreferrer", children: "REST and JSON" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://raygun.com/blog/soap-vs-rest-vs-json/#soapstand", target: "_blank", rel: "noopener noreferrer", children: "What does SOAP stand for?" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://raygun.com/blog/soap-vs-rest-vs-json/#reasonsoap", target: "_blank", rel: "noopener noreferrer", children: "What’s the main reason to use SOAP?" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://raygun.com/blog/soap-vs-rest-vs-json/#challengessoap", target: "_blank", rel: "noopener noreferrer", children: "Challenges/limitations in SOAP" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://raygun.com/blog/soap-vs-rest-vs-json/#table", target: "_blank", rel: "noopener noreferrer", children: "SOAP vs. REST comparison table" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://raygun.com/blog/soap-vs-rest-vs-json/#decide", target: "_blank", rel: "noopener noreferrer", children: "How to decide on SOAP or REST?" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://raygun.com/blog/soap-vs-rest-vs-json/#conclusion", target: "_blank", rel: "noopener noreferrer", children: "Conclusion" }) }), "\n"] }), "\n", _jsxs(_components.h2, { id: "what-are-web-services", children: [_jsx(_components.a, { className: "heading-link", href: "#what-are-web-services", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "What are web services?"] }), "\n", _jsxs(_components.p, { children: ["Web services are responsible for online machine-to-machine communication. Computers use web services to communicate via an internet connection. In fact, it’s only the front-end interfaces of websites and applications that reside on end users’ devices. The related data is stored on a remote server and transmitted to the client machine through APIs that provide web services for third-party users. APIs can use different architectures, such as ", _jsx(_components.a, { href: "https://www.guru99.com/comparison-between-web-services.html", target: "_blank", rel: "noopener noreferrer", children: "SOAP and REST" }), ", which act as API guidelines to transfer data from the server to the client."] }), "\n", _jsxs(_components.p, { children: ["SOAP is a standardized specification maintained by the ", _jsx(_components.a, { href: "https://www.w3.org/", target: "_blank", rel: "noopener noreferrer", children: "World Wide Web Consortium" }), " that is used for exchanging structured information in the form of well-defined, secure messages. For a long time, SOAP was the go-to messaging protocol that almost every web service used. However, with an increasing need for developers to build lightweight web and mobile applications, the more flexible REST architecture quickly gained popularity. REST is not a standardized protocol but a set of loose API guidelines that gives more freedom to developers and companies to decide how they want to transfer data over the network and structure their API calls."] }), "\n", _jsx(_components.p, { children: "These days, most public web services provide REST APIs and transfer data in the compact and easy-to-use JSON data interchange format. However, enterprise users still frequently choose SOAP for their web services." }), "\n", _jsx(_components.a, { href: "https://raygun.com/ebooks/the-developers-guide-to-core-web-vitals", target: "_blank", rel: "noopener noreferrer", children: _jsx(_components.img, { src: "https://raygun.com/blog/images/hero-content-promo/dev-guide.png", alt: "Developer's Guide to Core Web Vitals", className: "internal" }) }), "\n", _jsxs(_components.h2, { id: "the-main-differences-between-soap-and-rest", children: [_jsx(_components.a, { className: "heading-link", href: "#the-main-differences-between-soap-and-rest", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "The main differences between SOAP and REST"] }), "\n", _jsxs(_components.p, { children: ["SOAP and REST both allow you to create your own API, or ", _jsx(_components.a, { href: "https://raygun.com/blog/api-design-guidelines/", target: "_blank", rel: "noopener noreferrer", children: "Application Programming Interface" }), ". An API makes it possible to transfer data from an application to other applications, receiving requests and sending back responses through internet protocols such as HTTP, SMTP, and others."] }), "\n", _jsxs(_components.p, { children: ["Many popular websites provide public APIs for their users; for example, Google Maps has a ", _jsx(_components.a, { href: "https://developers.google.com/maps/documentation/javascript/tutorial", target: "_blank", rel: "noopener noreferrer", children: "public REST API" }), " that lets you customize Maps with your own content. There are also many APIs that have been created privately by companies for internal use. (If you’re new to structuring an API, start with ", _jsx(_components.a, { href: "https://raygun.com/blog/api-design-guidelines/", target: "_blank", rel: "noopener noreferrer", children: "our best practices for building a user-friendly API" }), ")."] }), "\n", _jsx(_components.p, { children: "SOAP and REST are two different API guidelines that approach the question of data transmission from differing points of view. REST was created to address the problems of SOAP." }), "\n", _jsxs(_components.p, { children: ["SOAP is a standardized protocol that sends messages using other protocols such as HTTP and SMTP. The ", _jsx(_components.a, { href: "https://www.w3.org/TR/soap12/", target: "_blank", rel: "noopener noreferrer", children: "SOAP specifications" }), " are official web standards, maintained and developed by the World Wide Web Consortium (W3C). As opposed to SOAP, REST is not a protocol but an architectural style. The REST architecture lays down a set of API guidelines to follow in order to provide a RESTful web service, for example, stateless existence and the use of HTTP status codes."] }), "\n", _jsx(_components.p, { children: "As SOAP is an official protocol, it comes with strict rules and advanced security features such as built-in ACID (Atomicity, Consistency, Isolation, Durability) compliance and authorization. Higher complexity requires more bandwidth and resources which can lead to slower page load times." }), "\n", _jsxs(_components.p, { children: ["REST was created as an alternative to the restrictions and limitations of SOAP, and therefore has a more flexible architecture. It consists of only loose guidelines and lets developers implement the recommendations in their own way. It allows different messaging formats, such as HTML, JSON, XML, and plain text, while SOAP only allows XML. REST is also a more lightweight architecture, so RESTful web services have better performance. Because of that, it’s become popular in the mobile era where even a ", _jsx(_components.a, { href: "https://raygun.com/blog/cost-of-software-errors/", target: "_blank", rel: "noopener noreferrer", children: "few seconds really matter" }), " (both in page load time and revenue)."] }), "\n", _jsxs(_components.h2, { id: "what-does-rest-stand-for", children: [_jsx(_components.a, { className: "heading-link", href: "#what-does-rest-stand-for", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "What does REST stand for?"] }), "\n", _jsx(_components.p, { children: "REST stands for Representational State Transfer. It’s an architectural style that defines a set of recommendations for designing loosely coupled applications that use the HTTP protocol for data transmission. REST doesn’t prescribe how to implement the principles at a lower level. Instead, REST guidelines allow developers to implement the details according to their own needs. Web services built following the REST architectural style are called RESTful web services." }), "\n", _jsxs(_components.p, { children: ["To create a REST API, you need to follow six architectural constraints: 1. Uniform interface: Requests from different clients should look the same. For example, the same resource shouldn’t have more than one URI. 2. Client-server separation: The client and the server should act independently. They should interact with each other only through requests and responses. 3. Statelessness: There shouldn’t be any server-side sessions. Each request should contain all the information the server needs to know. 4. Cacheable resources: Server responses should contain information about whether or not the data they send is cacheable. Cacheable resources should arrive with a version number so that the client can avoid requesting the same data more than once. 5. Layered system: There might be several layers of servers between the client and the server that returns the response. This shouldn’t affect either the request or the response. Code on demand (optional): When necessary, the response can contain executable code (e.g., ", _jsx(_components.a, { href: "https://raygun.com/languages/javascript", target: "_blank", rel: "noopener noreferrer", children: "JavaScript" }), " within an HTML response) that the client can execute."] }), "\n", _jsxs(_components.h2, { id: "whats-the-main-reason-to-use-rest", children: [_jsx(_components.a, { className: "heading-link", href: "#whats-the-main-reason-to-use-rest", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "What’s the main reason to use REST?"] }), "\n", _jsx(_components.p, { children: "REST is currently the most popular choice for building public APIs. You can find many examples all over the internet, especially since all the big social media sites provide REST APIs to allow developers to seamlessly integrate their apps with the platform. These public APIs also come with detailed documentation, providing all the information you need to pull data through the API." }), "\n", _jsxs(_components.p, { children: ["For example, Twitter has a number of ", _jsx(_components.a, { href: "https://developer.twitter.com/en/docs.html", target: "_blank", rel: "noopener noreferrer", children: "public REST APIs" }), " that all serve different purposes, such as a Search API to find historical tweets, a Direct Message API to send personalized messages, and an Ad API to help programmatically manage your ad campaigns."] }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.a, { href: "https://developer.wordpress.org/rest-api/", target: "_blank", rel: "noopener noreferrer", children: "WordPress REST API" }), " is another popular example of REST APIs. This provides endpoints for WordPress data types so that you can interact remotely with the content of a WordPress site and do some cool things like ", _jsx(_components.a, { href: "https://www.godaddy.com/garage/3-practical-use-cases-wp-rest-api/", target: "_blank", rel: "noopener noreferrer", children: "building mobile apps with WordPress" }), ". Even ", _jsx(_components.a, { href: "https://raygun.com/documentation/product-guides/crash-reporting/api/", target: "_blank", rel: "noopener noreferrer", children: "Raygun’s own APIs" }), " are REST-oriented! ", _jsx(_components.a, { href: "https://nordicapis.com/rest-better-than-soap-yes-use-cases/", target: "_blank", rel: "noopener noreferrer", children: "According to Nordic APIs" }), ", REST is almost always better for web-based APIs because it makes data available as resources (e.g. user) as opposed to services (e.g., getUser) which is how SOAP operates. REST also inherits HTTP operations, meaning you can make simple API calls ", _jsx(_components.a, { href: "https://restfulapi.net/http-methods/", target: "_blank", rel: "noopener noreferrer", children: "using well-known HTTP verbs" }), " such as GET, POST, PUT, and DELETE."] }), "\n", _jsxs(_components.h2, { id: "challengeslimitations-in-rest", children: [_jsx(_components.a, { className: "heading-link", href: "#challengeslimitations-in-rest", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Challenges/limitations in REST"] }), "\n", _jsx(_components.p, { children: "As REST is a stateless architecture by definition (see the third architectural constraint), sessions can’t be maintained in web services. So, each API call needs to be completely independent and include all the necessary data since it can’t depend on previous calls. This can be an issue if your web service requires stateful operations, consisting of a chain of messages that rely on each other for information." }), "\n", _jsx(_components.p, { children: "Even though REST is a more flexible architecture, it’s also less secure. There’s no contract between the client and server as in the case of the SOAP protocol, so it’s not recommended for web services where you need to transfer highly confidential data over the network. You’ll also need to create and maintain detailed documentation for your web service so that users of your REST API can understand the nature and implications of each API call." }), "\n", _jsxs(_components.p, { children: ["The REST architecture allows API providers to deliver data in multiple formats such as plain text, HTML, XML, YAML, and JSON, which is one of its most loved features. With the increasing popularity of REST, the lightweight and human-readable ", _jsx(_components.a, { href: "https://www.json.org/", target: "_blank", rel: "noopener noreferrer", children: "JSON format" }), " has also quickly gained traction, as it’s so well suited for quick data exchange."] }), "\n", _jsxs(_components.p, { children: ["JSON stands for JavaScript Object Notation. It’s an easy-to-parse and lightweight data-interchange format. In spite of its name, JSON is completely language-agnostic, so it can be used with any programming language, not just JavaScript. Its syntax is a subset of the ", _jsx(_components.a, { href: "https://www.ecma-international.org/publications/files/ECMA-ST-ARCH/ECMA-262,%203rd%20edition,%20December%201999.pdf", target: "_blank", rel: "noopener noreferrer", children: "Standard ECMA-262 3rd Edition" }), ". JSON files consist of collections of name/value pairs and ordered lists of values that are universal data structures used by most programming languages. Therefore, JSON can be easily integrated with any language."] }), "\n", _jsxs(_components.p, { children: ["To see the difference between XML and JSON, here’s example code from the API docs of ", _jsx(_components.a, { href: "https://developer.atlassian.com/server/crowd/", target: "_blank", rel: "noopener noreferrer", children: "Atlassian’s Crowd Server" }), " that allows you to request and accept data in both XML and JSON formats:"] }), "\n", _jsx(_components.pre, { children: _jsxs(_components.code, { className: "language-auto code-highlight", children: [_jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "my_username\n" }), _jsx(_components.span, { className: "code-line", children: "my_password\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "remote_address\n" }), _jsx(_components.span, { className: "code-line", children: "127.0.0.1\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "\n" })] }) }), "\n", _jsx(_components.p, { children: "This is how the above XML code looks in JSON:" }), "\n", _jsx(_components.pre, { children: _jsxs(_components.code, { className: "language-auto code-highlight", children: [_jsx(_components.span, { className: "code-line", children: "{\n" }), _jsx(_components.span, { className: "code-line", children: "\"username\" : \"my_username\",\n" }), _jsx(_components.span, { className: "code-line", children: "\"password\" : \"my_password\",\n" }), _jsx(_components.span, { className: "code-line", children: "\"validation-factors\" : {\n" }), _jsx(_components.span, { className: "code-line", children: "\"validationFactors\" : [\n" }), _jsx(_components.span, { className: "code-line", children: "{\n" }), _jsx(_components.span, { className: "code-line", children: "\"name\" : \"remote_address\",\n" }), _jsx(_components.span, { className: "code-line", children: "\"value\" : \"127.0.0.1\"\n" }), _jsx(_components.span, { className: "code-line", children: "}\n" }), _jsx(_components.span, { className: "code-line", children: "]\n" }), _jsx(_components.span, { className: "code-line", children: "}\n" }), _jsx(_components.span, { className: "code-line", children: "}\n" })] }) }), "\n", _jsx(_components.p, { children: "As you can see, JSON is a more lightweight and less verbose format, and it’s easier to read and write as well. In most cases, it’s ideal for data interchange over the internet. However, XML still has some advantages. For example, it allows you to place metadata within tags and also handles mixed content better — especially when mixed node arrays require detailed expressions." }), "\n", _jsxs(_components.h2, { id: "what-does-soap-stand-for", children: [_jsx(_components.a, { className: "heading-link", href: "#what-does-soap-stand-for", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "What does SOAP stand for?"] }), "\n", _jsx(_components.p, { children: "SOAP stands for Simple Object Access Protocol. It’s a messaging protocol for interchanging data in a decentralized and distributed environment. SOAP can work with any application layer protocol, such as HTTP, SMTP, TCP, or UDP. It returns data to the receiver in XML format. Security, authorization, and error-handling are built into the protocol and, unlike REST, it doesn’t assume direct point-to-point communication. Therefore, SOAP performs well in a distributed enterprise environment. SOAP follows a formal and standardized approach that specifies how to encode XML files returned by the API. A SOAP message is, in fact, an ordinary XML file that consists of the following parts:" }), "\n", _jsxs(_components.ol, { children: ["\n", _jsxs(_components.li, { children: [_jsx(_components.strong, { children: "Envelope (required)" }), ": This is the starting and ending tags of the message."] }), "\n", _jsxs(_components.li, { children: [_jsx(_components.strong, { children: "Header (optional)" }), ": It contains the optional attributes of the message. It allows you to extend a SOAP message in a modular and decentralized way."] }), "\n", _jsxs(_components.li, { children: [_jsx(_components.strong, { children: "Body (required)" }), ": It contains the XML data that the server transmits to the receiver."] }), "\n", _jsxs(_components.li, { children: [_jsx(_components.strong, { children: "Fault (optional)" }), ": It carries information about errors occurring during processing the message."] }), "\n"] }), "\n", _jsx(_components.p, { children: "Here is how an ordinary SOAP message looks. This example is from the W3C SOAP docs and it contains a SOAP envelope, a header block, and a body:" }), "\n", _jsx(_components.pre, { children: _jsxs(_components.code, { className: "language-auto code-highlight", children: [_jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "1\n" }), _jsx(_components.span, { className: "code-line", children: "2001-06-22T14:00:00-05:00\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "Pick up Mary at school at 2pm\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "\n" })] }) }), "\n", _jsxs(_components.h2, { id: "whats-the-main-reason-to-use-soap", children: [_jsx(_components.a, { className: "heading-link", href: "#whats-the-main-reason-to-use-soap", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "What’s the main reason to use SOAP?"] }), "\n", _jsx(_components.p, { children: "In the short- to medium-term future, SOAP will likely continue to be used for enterprise-level web services that require high security and complex transactions. APIs for financial services, payment gateways, CRM software, identity management, and telecommunication services are commonly used examples of SOAP." }), "\n", _jsxs(_components.p, { children: ["One of the most well-known SOAP APIs is the ", _jsx(_components.a, { href: "https://developer.paypal.com/api/rest/", target: "_blank", rel: "noopener noreferrer", children: "PayPal public API" }), " which allows you to accept payments, add a PayPal button to your website, let users log in with PayPal, and perform other actions."] }), "\n", _jsx(_components.p, { children: "Legacy system support is another frequent case for using SOAP. Popular web services that have been around for a while might have many users who still connect to their services through their existing SOAP API. Salesforce, for example, provides both a SOAP and a REST API so that every developer can integrate Salesforce with their own platform in a way that suits them." }), "\n", _jsx(_components.p, { children: "Despite REST’s rapid rise, SOAP can be an excellent solution in certain circumstances. Although most web service providers want to exchange stateless requests and responses these days, in some cases, you may still need to process stateful operations. This happens in scenarios where you have to make a chain of operations act as one transaction—for instance, in the case of bank transfers." }), "\n", _jsx(_components.p, { children: "Although SOAP APIs are stateless by default, SOAP does support stateful operations that can be implemented using the WS-* (Web Services) Specifications that are built on top of the core XML and SOAP standards." }), "\n", _jsxs(_components.h2, { id: "challengeslimitations-in-soap", children: [_jsx(_components.a, { className: "heading-link", href: "#challengeslimitations-in-soap", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Challenges/limitations in SOAP"] }), "\n", _jsx(_components.p, { children: "As SOAP can only transfer messages as XML files, your SOAP API will be less performant, as XML is a verbose format compared to JSON. API calls made to your server will need more bandwidth and it will take more time to process the request and transfer the response back to the client." }), "\n", _jsx(_components.p, { children: "In SOAP, the client-server communication depends on WSDL (Web Service Description Language) contracts, which implies tight coupling. Therefore, it’s not recommended for loosely coupled applications as you can’t opt out of using a contract between the client and the server." }), "\n", _jsx(_components.p, { children: "SOAP also has a higher learning curve, is harder to code, and can’t be tested in the web browser (as opposed to REST). With SOAP, you need to generate contracts in WSDL, create client stubs, follow strict specifications, and more. This also means that as a programmer, you’ll also have less freedom of choice." }), "\n", _jsxs(_components.h2, { id: "soap-vs-rest-comparison-table", children: [_jsx(_components.a, { className: "heading-link", href: "#soap-vs-rest-comparison-table", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "SOAP vs. REST comparison table"] }), "\n", _jsx(_components.p, { children: "Although REST has become the more popular choice, SOAP still has its place in the world of web services. To help you choose between them, here’s a comparison table of SOAP and REST that highlights the main differences between the two API styles:" }), "\n", _jsx(_components.div, { className: "overflow-x-auto", children: _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: " " }), _jsx(_components.th, { children: "SOAP" }), _jsx(_components.th, { children: "REST" })] }) }), _jsxs(_components.tbody, { children: [_jsxs(_components.tr, { children: [_jsx(_components.td, { children: "Meaning" }), _jsx(_components.td, { children: "Simple Object Access Protocol" }), _jsx(_components.td, { children: "Representational State Transfer" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: _jsx(_components.strong, { children: "Design" }) }), _jsx(_components.td, { children: _jsx(_components.strong, { children: "Standardized protocol with pre-defined rules to follow." }) }), _jsx(_components.td, { children: _jsx(_components.strong, { children: "Architectural style with loose guidelines and recommendations." }) })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "Approach" }), _jsx(_components.td, { children: "Function-driven (data available as services, e.g.: “getUser”)" }), _jsx(_components.td, { children: "Data-driven (data available as resources, e.g. “user”)." })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: _jsx(_components.strong, { children: "Statefulness" }) }), _jsx(_components.td, { children: _jsx(_components.strong, { children: "Stateless by default, but it’s possible to make a SOAP API stateful." }) }), _jsx(_components.td, { children: _jsx(_components.strong, { children: "Stateless (no server-side sessions)." }) })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "Caching" }), _jsx(_components.td, { children: "API calls cannot be cached." }), _jsx(_components.td, { children: "API calls can be cached." })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: _jsx(_components.strong, { children: "Security" }) }), _jsx(_components.td, { children: _jsx(_components.strong, { children: "WS-Security with SSL support. Built-in ACID compliance." }) }), _jsx(_components.td, { children: _jsx(_components.strong, { children: "Supports HTTPS and SSL." }) })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "Performance" }), _jsx(_components.td, { children: "Requires more bandwidth and computing power." }), _jsx(_components.td, { children: "Requires fewer resources." })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: _jsx(_components.strong, { children: "Message format" }) }), _jsx(_components.td, { children: _jsx(_components.strong, { children: "Only XML." }) }), _jsx(_components.td, { children: _jsx(_components.strong, { children: "Plain text, HTML, XML, JSON, YAML, and others." }) })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "Transfer protocol(s)" }), _jsx(_components.td, { children: "HTTP, SMTP, UDP, and others." }), _jsx(_components.td, { children: "Only HTTP" })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: _jsx(_components.strong, { children: "Recommended for" }) }), _jsx(_components.td, { children: _jsx(_components.strong, { children: "Enterprise apps, high-security apps, distributed environment, financial services, payment gateways, telecommunication services." }) }), _jsx(_components.td, { children: _jsx(_components.strong, { children: "Public APIs for web services, mobile services, social networks." }) })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "Advantages" }), _jsx(_components.td, { children: "High security, standardized, extensibility." }), _jsx(_components.td, { children: "Scalability, better performance, browser-friendliness, flexibility." })] }), _jsxs(_components.tr, { children: [_jsx(_components.td, { children: _jsx(_components.strong, { children: "Disadvantages" }) }), _jsx(_components.td, { children: _jsx(_components.strong, { children: "Poorer performance, more complexity, less flexibility." }) }), _jsx(_components.td, { children: _jsx(_components.strong, { children: "Less security, not suitable for distributed environments." }) })] })] })] }) }), "\n", _jsxs(_components.h2, { id: "how-to-decide-on-soap-or-rest", children: [_jsx(_components.a, { className: "heading-link", href: "#how-to-decide-on-soap-or-rest", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "How to decide on SOAP or REST"] }), "\n", _jsx(_components.p, { children: "Both SOAP and REST web services are platform-independent, which means that the client and server machines can use different technologies and programming languages." }), "\n", _jsx(_components.p, { children: "To decide whether to use SOAP vs REST for your web service, you’ll need to take the following factors into consideration:" }), "\n", _jsxs(_components.ul, { children: ["\n", _jsxs(_components.li, { children: [_jsx(_components.strong, { children: "Coupling:" }), " for loosely coupled applications, choose REST, while for tightly coupled applications, go with SOAP. Most modern web and mobile applications provide loosely coupled web services."] }), "\n", _jsxs(_components.li, { children: [_jsx(_components.strong, { children: "State:" }), " if you need to process stateful operations and have complex API calls in which subsequent messages rely on each other, opt for SOAP. However, if your operations are stateless, REST is almost always the better option, especially because it also allows you to store data in the cache of the user’s browser (not suitable for high-security data)."] }), "\n", _jsxs(_components.li, { children: [_jsx(_components.strong, { children: "Security:" }), " if you need to comply with security law or you transfer highly sensitive data, go with SOAP."] }), "\n", _jsxs(_components.li, { children: [_jsx(_components.strong, { children: "Knowledge of your team:" }), " as SOAP has a higher learning curve, you’ll need developers who have sufficient knowledge. It’s generally easier to find developers who have experience with creating REST APIs."] }), "\n"] }), "\n", _jsx(_components.p, { children: "Overall, if you don’t have a specific reason (like security or a tightly coupled enterprise application) to use SOAP, REST will most likely be the better choice. It’s not just easier to code, test, and maintain, but the data transfer requires less bandwidth, so you can provide a faster web service." }), "\n", _jsxs(_components.h2, { id: "each-approach-has-its-applications", children: [_jsx(_components.a, { className: "heading-link", href: "#each-approach-has-its-applications", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Each approach has its applications"] }), "\n", _jsx(_components.p, { children: "In this post, we’ve discussed how SOAP vs REST vs JSON are related to each other and web services. First, we’ve covered the main differences between SOAP vs REST, web service architectures, the reasons behind their use, and what challenges they pose. We’ve also discussed JSON, which is neither a protocol nor an architectural style but a compact data format that you can use in RESTful services. As we’ve established, both SOAP and REST have their advantages and disadvantages. Even though REST has emerged as the most popular approach to developing web services, and is ideal for loosely coupled applications, fast development, and data transfer via JSON messages, SOAP is still the better choice in some cases, especially when your API needs to ensure high security." }), "\n", _jsx(_components.p, { children: _jsxs(_components.strong, { children: ["If you’re committed to improving the quality of your software, check out ", _jsx(_components.a, { href: "https://raygun.com/", target: "_blank", rel: "noopener noreferrer", children: "Raygun error and performance monitoring" }), ". Get full visibility into the health of your software to deliver fast and error-free experiences - and you can ", _jsx(_components.a, { href: "https://app.raygun.com/signup", target: "_blank", rel: "noopener noreferrer", children: "try it out for free!" })] }) }), "\n", _jsxs(_components.h3, { id: "further-reading", children: [_jsx(_components.a, { className: "heading-link", href: "#further-reading", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Further reading"] }), "\n", _jsxs(_components.ul, { children: ["\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://en.wikipedia.org/wiki/SOAP", target: "_blank", rel: "noopener noreferrer", children: "Wikipedia on SOAP" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://www.codecademy.com/articles/what-is-rest", target: "_blank", rel: "noopener noreferrer", children: "Codecademy on REST" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://raygun.com/blog/api-design-guidelines/", target: "_blank", rel: "noopener noreferrer", children: "API Design guidelines for building a user-friendly API" }) }), "\n", _jsx(_components.li, { children: _jsx(_components.a, { href: "https://raygun.com/blog/postman-best-practices/", target: "_blank", rel: "noopener noreferrer", children: "How Raygun’s engineering team uses Postman to send API data" }) }), "\n"] })] }); } function MDXContent(props = {}) { const {wrapper: MDXLayout} = { ..._provideComponents(), ...props.components }; return MDXLayout ? _jsx(MDXLayout, { ...props, children: _jsx(_createMdxContent, { ...props }) }) : _createMdxContent(props); } return { default: MDXContent };