Hi, my name is Shama Farag. Here, we will be navigating together my portfolio project API User Guide for Beginners. This is an introductory session about APIs, the benefits of APIs, types of APIs, how to start using an API, how to create an API.
An API or Applications Programming Interface is a mediator through which different web applications communicate and integrate with each other. APIs helps to connect applications together to enhance apps functionality and improve the user experience. Like the Facebook app, it connects to the internet and sends data to a server when you log in. The Facebook application will communicate with the server, then interpret that data and give you the information you wanted in a way that you can read. All this happens through an API.
Benefits of APIs
1- Efficient and saves time
2- APIs provide applications with the most recent image recognition and the best language processing methods.
3- APIs prevent inaccuracy and loss of data.
Types of APIs
• Open APIs: They are Public APIs, and they have no restrictions to access because they are publicly available.
• Partner APIs: You will need specific rights or licenses to access this type of APIs.
• Internal APIs: These are Private APIs; only internal systems use this type of APIs inside the company to enhance its products and services.
• Composite APIs: This type of APIs combines different data and service APIs. Mainly used to speed up the execution process and improve the performance of the user’s experiment.
How to Start Using an API?
1-Get an API Key
Sign up for RapidAPI, for instance. Use username, email, and password; Google, Facebook, or Github account.
2-Test API Endpoints
An API endpoint is a fancy word for a URL of a server or service, and it refers to touchpoints of the communication between an API and a server check functionality. Register with the RapidAPI service and subscribe.
3-Create your first App
Use RapidAPI. Use the Code Snippet block. Choose a programming language. Get the code you tested through RapidAPI. Use NodeJS, PHP, Python, Ruby, Objective-C, Java, and C#
API Documentation
• APIs are three groups: Software API, SCPI (Hardware API), Web API.
• There are many technical writing tools, like Mapcap Flare, ClickHelp, Help&Manual, Dr.Explain, HelpNDoc, Adobe RoboHelp.
How to Create an API
See tutorials
Using Postman to Explore API
Postman is an API platform for building and using APIs. Postman makes it easier to use API lifecycle and enhances collaboration to create better APIs—faster.
API Services
• To save some space on the user’s device.
• Applications use API for certain tasks like registration and login, client messaging, files, and database access and storage.
Tutorials And Resources
Web APIs (w3schools.com)
Documenting APIs: A guide for technical writers and engineers | Documenting APIs (idratherbewriting.com)
Информация по комментариям в разработке