农场js_通过销售农场商品来解释Web API
農(nóng)場(chǎng)js
by Kevin Kononenko
凱文·科諾年科(Kevin Kononenko)
通過銷售農(nóng)場(chǎng)商品來解釋W(xué)eb API (Web APIs explained by selling goods from your farm)
If you have been to a farmer’s market or farm stand, then you can understand the concept of an application programming interface (API).
如果您去過農(nóng)民的市場(chǎng)或農(nóng)場(chǎng)攤位，那么您可以了解應(yīng)用程序編程接口(API)的概念。
If you are new to web development, you probably hear the term “API” a lot.
如果您不熟悉Web開發(fā)，則可能會(huì)經(jīng)常聽到“ API”一詞。
“I can’t wait until that company releases their public API!”
“我等不及該公司發(fā)布其公共API！”
“That company’s API is a confusing mess.”
“該公司的API令人一團(tuán)糟。”
“Do they have an endpoint for that data in their API?”
“他們的API中是否有該數(shù)據(jù)的端點(diǎn)？”
Understanding the concept of an application programming interface (API) can be pretty difficult if you are not familiar with concepts like SOAP, HTTP, and XML.
如果您不熟悉SOAP，HTTP和XML等概念，那么理解應(yīng)用程序編程接口(API)的概念可能會(huì)非常困難。
So, I wanted to find a way to explain the way that web APIs work as a whole, so that when you get into the nitty-gritty technical details, you will understand how it all fits together.
因此，我想找到一種方法來解釋W(xué)eb API作為一個(gè)整體的工作方式，以便當(dāng)您深入了解具體的技術(shù)細(xì)節(jié)時(shí)，您將了解它們?nèi)绾谓Y(jié)合在一起。
In this tutorial, you are the owner of a farm that sells five products: chicken, pork, eggs, tomatoes, and corn.
在本教程中，您是一個(gè)農(nóng)場(chǎng)的所有者，該農(nóng)場(chǎng)出售五種產(chǎn)品：雞肉，豬肉，雞蛋，西紅柿和玉米。
In order to understand this tutorial, you just need to understand the difference between server-side code (back-end) and client-side code (front-end). You can read the beginning of my guide to GET/POST if you are not already familiar with server vs. client.
為了理解本教程，您只需要了解服務(wù)器端代碼(后端)和客戶端代碼(前端)之間的區(qū)別。 如果您還不熟悉服務(wù)器與客戶端，則可以閱讀GET / POST指南的開頭。
GUI和API之間的區(qū)別 (The Difference Between A GUI and an API)
Let’s start with a familiar way to use the web. The web browser, like Chrome, is an example of a graphical user interface (GUI). As the user, you can interact with a user-friendly tool in order to accomplish tasks, like booking flights or searching Google.
讓我們從熟悉的網(wǎng)絡(luò)使用方式開始。 像Chrome這樣的網(wǎng)絡(luò)瀏覽器是圖形用戶界面(GUI)的示例。 作為用戶，您可以與用戶友好的工具進(jìn)行交互，以完成任務(wù)，例如預(yù)訂航班或搜索Google。
The GUI allows website visitors to interact with code on the server in a controlled and structured fashion.
GUI允許網(wǎng)站訪問者以受控和結(jié)構(gòu)化的方式與服務(wù)器上的代碼進(jìn)行交互。
As a farm owner, this is kind of like the farm stand that you set up on your property or your stall at the farmer’s market.
作為農(nóng)場(chǎng)主，這有點(diǎn)像您在物業(yè)上設(shè)置的農(nóng)場(chǎng)攤位或在農(nóng)夫市場(chǎng)上的攤位。
You can’t just stack your goods inside your barn, allow visitors to come in, and then expect to make money. Instead, you need to set up a booth so visitors can quickly understand your available goods and pricing.
您不能只是將貨物堆放在谷倉內(nèi)，讓訪客進(jìn)來，然后期望賺錢。 相反，您需要設(shè)置一個(gè)攤位，以便訪客可以快速了解您的可用商品和價(jià)格。
This is the way that customers “interact” with your hard work. They don’t need to understand the planting process, or the equipment you use, or the processing. They just see the final product.
這是客戶與您的辛勤工作“互動(dòng)”的方式。 他們不需要了解種植過程，您使用的設(shè)備或加工過程。 他們只是看到最終產(chǎn)品。
Notice how every customer experiences a one-to-one interaction. When they arrive at your stall, they are only looking at products from your farm.
注意每個(gè)客戶如何體驗(yàn)一對(duì)一的互動(dòng)。 當(dāng)他們到達(dá)您的攤位時(shí)，他們只是在看您農(nóng)場(chǎng)的產(chǎn)品。
那么什么是API？ (Then What Is An API?)
There are other ways to sell your products besides direct to consumer. You can also sell to distributors and local restaurants, so that your products can be included in different dishes or sold in a grocery store.
除了直接銷售給消費(fèi)者外，還有其他銷售產(chǎn)品的方法。 您還可以出售給分銷商和當(dāng)?shù)夭宛^，這樣您的產(chǎn)品可以包含在不同的菜肴中，也可以在雜貨店出售。
This is a new way for consumers to “experience” your product. Sure, they might not know whose eggs are in their omelette when they order breakfast at the local diner, but they are still “using” your product.
這是消費(fèi)者“體驗(yàn)”您的產(chǎn)品的新途徑。 當(dāng)然，他們?cè)诋?dāng)?shù)氐牟宛^點(diǎn)早餐時(shí)可能不知道誰的雞蛋在煎蛋中，但他們?nèi)栽凇笆褂谩蹦漠a(chǎn)品。
But, from your perspective as a farm owner, you have a completely different sales process and supply chain. Now, you don’t need to carefully arrange a booth for consumers. Instead, you probably need to add a shipping bay to your barn so that distributors and restaurants can pull up their trucks and load up. You also need to package your goods for larger sales.
但是，從您作為農(nóng)場(chǎng)主的角度來看，您擁有完全不同的銷售流程和供應(yīng)鏈。 現(xiàn)在，您無需為消費(fèi)者精心安排攤位。 取而代之的是，您可能需要在谷倉中增加一個(gè)運(yùn)輸區(qū)，以便分銷商和飯店可以拉起卡車來裝貨。 您還需要包裝商品以提高銷量。
This is similar to the concept of an API. When you build an API, you make it possible for other developers to access your data and use it in their applications.
這類似于API的概念。 構(gòu)建API時(shí)，其他開發(fā)人員可以訪問您的數(shù)據(jù)并在其應(yīng)用程序中使用它們。
Just like restaurant customers can “experience” your chickens’ eggs by eating an omelette, website users can “experience” your product on somebody else’s website through a widget on the website or code on the other company’s servers.
就像餐廳客戶可以通過吃煎蛋來“體驗(yàn)”雞的蛋一樣，網(wǎng)站用戶也可以通過網(wǎng)站上的小部件或另一家公司的服務(wù)器上的代碼在別人的網(wǎng)站上“體驗(yàn)”您的產(chǎn)品。
Now, we have a new level of interaction. Your distributors and restaurant customers might interact with you one-on-one by visiting the farm, but they then expose thousands of customers to your products when they sell them later.
現(xiàn)在，我們有了新的互動(dòng)水平。 您的分銷商和餐廳客戶可能會(huì)通過訪問農(nóng)場(chǎng)與您進(jìn)行一對(duì)一的互動(dòng)，但是當(dāng)他們以后出售產(chǎn)品時(shí)，他們就會(huì)使成千上萬的客戶接觸到您的產(chǎn)品。
As the farm owner, you still must set up processes so that you can successfully serve these distributors. Similarly, an API is a structured way that others can utilize your server-side code. As the developer, you still have full control.
作為服務(wù)器場(chǎng)所有者，您仍然必須設(shè)置流程，以便可以成功為這些分發(fā)服務(wù)器提供服務(wù)。 同樣，API是其他人可以利用您的服務(wù)器端代碼的一種結(jié)構(gòu)化方式。 作為開發(fā)人員，您仍然擁有完全控制權(quán)。
I used a search widget as an example in the image above, but really, just about anything could be used to access an API. That is just one example of a common way that website users experience APIs from 3rd parties. Other common ones include:
我在上圖中以搜索小部件為例，但實(shí)際上，幾乎任何東西都可以用來訪問API。 這只是網(wǎng)站用戶體驗(yàn)來自第三方的API的一種常見方式的示例。 其他常見的包括：
- Mapping tools 貼圖工具
- Payment processing 交付過程
- Weather data 天氣資料
通過API可以訪問什么？ (What Can Be Accessed Through An API?)
Let’s say that you want to start selling eggs from your farm to distributors and restaurants. You would need to set up a series of processes on your farm to support this:
假設(shè)您要開始從農(nóng)場(chǎng)向分銷商和飯店銷售雞蛋。 您需要在服務(wù)器場(chǎng)上設(shè)置一系列過程來支持此操作：
Before you set up all these processes, you need to decide whether you are ready to accept mass orders of eggs in the first place. Do you have enough hens to produce the right number of eggs on a weekly basis? If you don’t, you may put too much strain on your system and disappoint your customers when you run out of eggs.
在設(shè)置所有這些過程之前，您需要首先確定是否準(zhǔn)備好接受大量的雞蛋訂單。 您是否有足夠的母雞每周生產(chǎn)適當(dāng)數(shù)量的雞蛋？ 如果不這樣做，可能會(huì)給系統(tǒng)造成太大的壓力，并在雞蛋用完時(shí)使客戶失望。
API developers set up endpoints that allow other developers to access specific data from their database. The example above would be an “eggs” endpoint. If you do not create one in the first place, then customers cannot buy eggs from you.
API開發(fā)人員設(shè)置了端點(diǎn) ，允許其他開發(fā)人員從其數(shù)據(jù)庫訪問特定數(shù)據(jù)。 上面的示例將是一個(gè)“雞蛋”端點(diǎn)。 如果您不首先創(chuàng)建一個(gè)雞蛋，那么客戶將無法從您那里購買雞蛋。
You can set up specific endpoints for each product from your farm- chickens, pork, eggs, tomatoes and corn. Some may only be accessible through the farmer’s market (GUI) because you are not sure if you are ready to ramp up production to meet the needs of distributors.
您可以為農(nóng)場(chǎng)，雞肉，豬肉，雞蛋，西紅柿和玉米中的每種產(chǎn)品設(shè)置特定的終點(diǎn)。 有些產(chǎn)品可能只能通過農(nóng)貿(mào)市場(chǎng)(GUI)訪問，因?yàn)槟淮_定是否準(zhǔn)備增加產(chǎn)量以滿足分銷商的需求。
That is one difference between an API and an open-source database. In an open-source database, everything can be queried and accessed. When you set up an API for your back-end, you create endpoints that reveal only specific data.
那是API和開放源代碼數(shù)據(jù)庫之間的區(qū)別。 在開源數(shù)據(jù)庫中，所有內(nèi)容都可以查詢和訪問。 在為后端設(shè)置API時(shí)，您將創(chuàng)建僅顯示特定數(shù)據(jù)的終結(jié)點(diǎn)。
Just like distributors are the ones that can now interact with your farm, developers from other companies are the ones that interact with your API. Once they write code that accesses data from your server, their website visitors can have new experiences based on your data.
就像分銷商現(xiàn)在可以與您的服務(wù)器場(chǎng)進(jìn)行交互一樣，其他公司的開發(fā)人員也可以與您的API進(jìn)行交互。 一旦他們編寫了從您的服務(wù)器訪問數(shù)據(jù)的代碼，他們的網(wǎng)站訪問者就可以根據(jù)您的數(shù)據(jù)獲得新的體驗(yàn)。
跟蹤單個(gè)API調(diào)用 (Tracking an Individual API Call)
Let’s say that you decided to set up an endpoint for eggs at your farm. A local restaurant wants to buy 1000 eggs to satisfy the 1000 omelette orders it receives each week.
假設(shè)您決定在您的農(nóng)場(chǎng)中設(shè)置雞蛋的端點(diǎn) 。 一家當(dāng)?shù)夭宛^希望購買1000個(gè)雞蛋，以滿足每周收到的1000個(gè)煎蛋訂單。
Notice how our API call actually starts with a user request? That may feel a little counter-intuitive based on the description.
注意我們的API調(diào)用實(shí)際上是如何從用戶請(qǐng)求開始的嗎？ 根據(jù)說明，這可能會(huì)有點(diǎn)違反直覺。
An individual API call occurs when some trigger happens, and code written by another developer sends a request to your API at a specific endpoint. Your API must deliver a response based on your server-side code.
當(dāng)某些觸發(fā)器發(fā)生時(shí)，將進(jìn)行單獨(dú)的API調(diào)用 ，并且由其他開發(fā)人員編寫的代碼會(huì)將請(qǐng)求發(fā)送到特定端點(diǎn)處的API。 您的API必須根據(jù)您的服務(wù)器端代碼傳遞響應(yīng)。
In this case, the trigger is the order of 1000 eggs. The restaurant manager has already created a relationship with a farm — your farm. And, your farm has already set up the processes to deliver 1000 eggs at a time.
在這種情況下，觸發(fā)器是1000個(gè)雞蛋的數(shù)量級(jí)。 飯店經(jīng)理已經(jīng)與一個(gè)農(nóng)場(chǎng)(您的農(nóng)場(chǎng))建立了關(guān)系。 而且，您的農(nóng)場(chǎng)已經(jīng)設(shè)置了一次可運(yùn)送1000枚雞蛋的過程。
So, the 1000 egg order comes in, and your farm delivers the response: 1000 eggs.
因此，輸入了1000個(gè)雞蛋，您的服務(wù)器場(chǎng)將做出響應(yīng)：1000個(gè)雞蛋。
Keep in mind, there might be 100 other restaurants that have created a relationship with your farm, and 10 of them may send a request at the same time! That is where scalability comes into play. You need to decide if your server is ready to handle that demand. But that is a topic for another tutorial!
請(qǐng)記住，可能還有100家其他餐館與您的農(nóng)場(chǎng)建立了聯(lián)系，其中10家可能同時(shí)發(fā)送請(qǐng)求 ！ 這就是可伸縮性發(fā)揮作用的地方。 您需要確定服務(wù)器是否已準(zhǔn)備好處理該需求。 但這是另一個(gè)教程的主題！
Here is the technical version of the sequence above, if you had a mapping application that could be used on other websites like Google Maps.
如果您有可以在其他網(wǎng)站(例如Google Maps)上使用的地圖繪制應(yīng)用程序，則這是上述序列的技術(shù)版本。
The developer on that other site has already written the code that will create a request to your API based on the action from that user
該其他站點(diǎn)上的開發(fā)人員已經(jīng)編寫了代碼，該代碼將根據(jù)該用戶的操作向您的API創(chuàng)建請(qǐng)求
The API call comes in, and your server delivers a response.
API調(diào)用進(jìn)入，您的服務(wù)器將提供響應(yīng)。
Of course, there are probably 1000 other web apps that are using your mapping widget, so you need to be prepared for all those API calls!
當(dāng)然，可能還有1000個(gè)其他Web應(yīng)用程序正在使用您的映射小部件，因此您需要為所有這些API調(diào)用做好準(zhǔn)備！
GET和POST的示例 (Examples of GET and POST)
Here is a quick refresher on GET and POST if you need to read up.
如果您需要閱讀，這里是關(guān)于GET和POST的快速復(fù)習(xí) 。
So far, in our farm examples, the requests in our little scenario have resembled GET requests. Due to requests triggered by the restaurant’s customers, the restaurant must send a truck to your farm to pick up eggs.
到目前為止，在我們的服務(wù)器場(chǎng)示例中，我們的小場(chǎng)景中的請(qǐng)求類似于GET請(qǐng)求。 由于餐廳顧客的要求，餐廳必須派一輛卡車到您的農(nóng)場(chǎng)去撿雞蛋。
But what about POST requests? In a real world example, the Facebook API allows users of other apps to create posts, and then that app can send those posts directly to Facebook to go live immediately.
但是POST請(qǐng)求呢？ 在一個(gè)真實(shí)的示例中，Facebook API允許其他應(yīng)用程序的用戶創(chuàng)建帖子，然后該應(yīng)用程序可以將這些帖子直接發(fā)送到Facebook以立即上線。
In some cases, like social media APIs, it may make sense to allow the end-user to post directly to a social platform from a third party app.
在某些情況下，例如社交媒體API，允許最終用戶直接從第三方應(yīng)用發(fā)布到社交平臺(tái)可能很有意義。
But here is another example. The Amazon API allows online store owners to programmatically post their products to Amazon’s Marketplace. In that situation, the developer on the team of the independent online store owner can also create a presence on Amazon. So, the API does not involve any sort of end user or website visitor.
但這是另一個(gè)例子。 Amazon API允許在線商店所有者以編程方式將其產(chǎn)品發(fā)布到Amazon的Marketplace。 在這種情況下，獨(dú)立在線商店所有者團(tuán)隊(duì)的開發(fā)人員也可以在Amazon上創(chuàng)建業(yè)務(wù)。 因此，API不涉及任何類型的最終用戶或網(wǎng)站訪問者。
In our farm example, this is kind of like the way you might handle monthly billing. After restaurants and distributors visit your farm all month to buy products, you send them a bill at the end of the month that details the payment they must send.
在我們的服務(wù)器場(chǎng)示例中，這類似于您處理每月帳單的方式。 餐館和分銷商整月訪問您的農(nóng)場(chǎng)購買產(chǎn)品后，您會(huì)在月底向他們發(fā)送賬單，其中詳細(xì)說明了他們必須發(fā)送的付款。
Just like the restaurant must build their own processes to make sure they collect eggs at the right time, they must also have a process for paying you on time. This probably involves their accountant. Let’s say that the accountant knows that they must pay you on the first of the month.
就像餐廳必須建立自己的流程以確保他們?cè)谡_的時(shí)間收集雞蛋一樣，他們還必須具有按時(shí)付款的流程。 這可能涉及他們的會(huì)計(jì)師。 假設(shè)會(huì)計(jì)師知道他們必須在每月的第一天付錢給您。
Now, how might the user/customer trigger a POST request? Well, imagine that the restaurant immediately sent you a payment each time someone ordered food that came from your farm. If a person ordered a $5 omelette, and $2 of the cost came from the eggs from your farm, the restaurant would immediately send the $2 to your bank account. If this was a web app, that level of communication might work, but since this is a farming example, that would be a little impractical.
現(xiàn)在，用戶/客戶如何觸發(fā)POST請(qǐng)求？ 好吧，想象一下，每當(dāng)有人訂購從您的農(nóng)場(chǎng)來的食物時(shí)，餐廳立即向您付款。 如果某人訂購了5美元的煎蛋，而其中2美元的費(fèi)用來自您農(nóng)場(chǎng)的雞蛋，那么餐廳將立即將2美元發(fā)送到您的銀行帳戶。 如果這是一個(gè)Web應(yīng)用程序，則該級(jí)別的通信可能會(huì)起作用，但是由于這是一個(gè)農(nóng)業(yè)示例，因此這不太實(shí)際。
服務(wù)器場(chǎng)和Web應(yīng)用程序之間的區(qū)別 (The Difference Between a Farm and a Web App)
As you can start to see in the last example, there is one major difference between our little farm supply chain and an API call. Timing.
正如您在上一個(gè)示例中開始看到的那樣，我們的小型農(nóng)場(chǎng)供應(yīng)鏈和API調(diào)用之間存在一個(gè)主要區(qū)別。 定時(shí)。
Simply due to the logistics of the real world… we cannot hope to match the instantaneous nature of most API calls, even if the steps are generally the same.
僅僅由于現(xiàn)實(shí)世界的后勤……我們不能希望匹配大多數(shù)API調(diào)用的瞬時(shí)性質(zhì)，即使步驟通常相同。
Let’s look at the example GET request from earlier in the tutorial.
讓我們看一下本教程前面的示例GET請(qǐng)求。
Here is what that means in web development terms.
這就是Web開發(fā)術(shù)語的含義。
But if we draw the analogy to a real-world farm:
但是，如果將此類比喻為現(xiàn)實(shí)世界中的農(nóng)場(chǎng)：
It would be incredibly impractical to send a truck to a farm to make the freshest omelette known to humankind. But, the steps are still the same. So I just wanted to mention this difference in timing.
將卡車送至農(nóng)場(chǎng)以使人類知道最新鮮的煎蛋是非常不切實(shí)際的。 但是，步驟仍然相同。 所以我只想提一下時(shí)間上的差異。
But, when a user triggers a request when they use a web application, they usually get a nearly instant response.
但是，當(dāng)用戶在使用Web應(yīng)用程序時(shí)觸發(fā)請(qǐng)求時(shí)，他們通常會(huì)獲得幾乎即時(shí)的響應(yīng)。
“打開您的API”是什么意思？ (What Does It Mean To “Open Your API”?)
So let’s return to our original question: What does it mean when a company “opens their API”?
因此，讓我們回到最初的問題：一家公司“開放其API”意味著什么？
It means that they have valuable data available on their server that they can now reveal via specific endpoints. The company gets to determine how developers from other companies can access their data, but at the same time, they are making it widely available in a structured way.
這意味著他們?cè)诜?wù)器上擁有有價(jià)值的數(shù)據(jù)，現(xiàn)在可以通過特定的端點(diǎn)顯示這些數(shù)據(jù)。 該公司可以確定其他公司的開發(fā)人員如何訪問他們的數(shù)據(jù)，但與此同時(shí)，他們正在以結(jié)構(gòu)化方式廣泛使用它們。
In our farm analogy, this is the point when your farm decides to sell your products to distributors and restaurants, and sets up the internal systems to handle mass orders.
在我們的農(nóng)場(chǎng)比喻中，這就是您的農(nóng)場(chǎng)決定將產(chǎn)品出售給分銷商和飯店并設(shè)置內(nèi)部系統(tǒng)以處理大量訂單的關(guān)鍵點(diǎn)。
喜歡本教程嗎？ (Enjoy this tutorial?)
If you enjoyed this tutorial, you will probably like the rest of my visualized guides to web development topics. Read further on the CodeAnalogies blog, or sign up hear to get the latest tutorials:
如果您喜歡本教程，則可能會(huì)喜歡我其他有關(guān)Web開發(fā)主題的可視化指南。 在CodeAnalogies博客上進(jìn)一步閱讀，或注冊(cè)Listen以獲取最新教程：
翻譯自: https://www.freecodecamp.org/news/web-apis-explained-by-selling-goods-from-your-farm-84aaf99cfc78/
農(nóng)場(chǎng)js
總結(jié)
以上是生活随笔為你收集整理的农场js_通过销售农场商品来解释Web API的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 女人梦到好多蛇是什么征兆
- 下一篇： 使用Express在Node.js中实现