I have postman collections of some rest apis that I delivered to someone who want to do a secure assessment on them, however he asked for full API documentation, and I'm not very familiar with rest APIs, so what is the difference? ain't postman collections are API documentation at the same time ?
what is the difference between postman collections and API documentation?
2.9k Views Asked by ethicalhacker At
1
There are 1 best solutions below
Related Questions in REST
- Query parameter works fine with fastapi application when tested locally but not working when the FastAPI application is deployed on AWS lambda
- Add an http GET/POST entry point to a Django with channels websocket
- Difficulty creating a data pipeline with Fabric Datafactory using REST
- Flutter connection to a local api
- Accessing REST API Status Codes using Azure Data Factory Copy Activity (or similar)?
- Mass Resource deletion in REST
- why when I check endpoint /tasks, an error always appears "error : invalid token" even though I have entered the appropriate token that I got
- How to prevent users from creating custom client apps?
- How to create a REST API with .NET Framework?
- Efficiently Handling Large Number of API Calls with Delphi 10.4 and OmniThreadLibrary
- Put Request throwing 401 [no body] Unauthorized
- Converting img src data to octet-stream
- Implementing Email Verification and Notification System in a Full-Stack Application with React Frontend and Node Backend
- Micronaut - Add Controller from external library
- Moving Template or OVA to Datastore using vCenter API
Related Questions in POSTMAN
- Issue uploading files in spring boot java to onedrive using API
- Cannot serialize (Spring Boot)
- why when I check endpoint /tasks, an error always appears "error : invalid token" even though I have entered the appropriate token that I got
- mTLS not working with FastAPI and Uvicorn
- How to set Postman Settings to mimic the effect the -k option of curl
- Postman Webservice PHP Curl Code POST request giving forbidden error when run in local
- Laravel 10 - Passport - Personal Access Client
- How to get OAuth2 Access token from Postman
- I am struggling to get a 200 success request for my Heroku-hosted API on Rapid API for GET requests. I only receive a '404 page not found' error
- Postman + Flask Sending large file stalls
- Postman HeaderList remote function not working
- On paste StartFragment - EndFragment Postman issue
- Not receiving WebSocket messages in Postman using Laravel and beyondcode/laravel-websockets package
- Use JMeter to simulate receiving websocket broadcasts similar to okhttp3
- Response body in Postman is not in human-readable way, with proper indentation and line breaks
Related Questions in POSTMAN-COLLECTION
- Postman Running collections against different environments
- Could not get Postman live collection
- when collection is converted to json, query property have weird schema
- How to run postman Collection and Environment in CMD using newman by using Postman APIKey
- Postman manipulate test data after requests
- what is the difference between postman collections and API documentation?
- How to pass argument or value while running newman from gitlab pipeline
- How to specific a output file when converting from version 1 to version 2
- How to specify JSON request body example in Postman Collection
- Exporting Cookies with Postman Collection
- How to generate code using Postman Collection
- Where is the Netsuite Webservices Postman Collection?
- Using Collection Variables in Postman
- How can we use Postman collection in Nightwatch?
- How to create JSON file from postman collection(s)
Related Questions in API-DOCUMENTATION
- How do I specify language when using OpenAI's Whisper's Python library? And where is its the documentation?
- What is the best API documentation approach for Ballerina record types?
- Where to find a detailed documentation of Superset REST API to create a chart/dashboard?
- Swagger/OAS Schema design discussion
- Large Swagger Json file into multi json files
- How to use swagger with a generic jaxrs api that writes response based on query params and response body is written using response builder class
- Add Custom Text Section in API documentation
- Which approach to choose in API management: "Code first" vs "Spec first"?
- how to customize the swagger UI/OpenApi in spring boot 3 without make my controller look clumsy
- Create custom index.html in asp.net core Redoc as Api-Documentation
- How to describe a model in Swagger for an array with simple objects?
- Redocly OpenAPI structure error. Property `openapi` is not expected here
- Set a JSDoc comment to generate API documentation without adding a TypeScript declaration to the .d.ts file
- OpenAPI 3.x.x having different response with the change of Optional Parameters
- How can I show some endpoints only admin
Trending Questions
- UIImageView Frame Doesn't Reflect Constraints
- Is it possible to use adb commands to click on a view by finding its ID?
- How to create a new web character symbol recognizable by html/javascript?
- Why isn't my CSS3 animation smooth in Google Chrome (but very smooth on other browsers)?
- Heap Gives Page Fault
- Connect ffmpeg to Visual Studio 2008
- Both Object- and ValueAnimator jumps when Duration is set above API LvL 24
- How to avoid default initialization of objects in std::vector?
- second argument of the command line arguments in a format other than char** argv or char* argv[]
- How to improve efficiency of algorithm which generates next lexicographic permutation?
- Navigating to the another actvity app getting crash in android
- How to read the particular message format in android and store in sqlite database?
- Resetting inventory status after order is cancelled
- Efficiently compute powers of X in SSE/AVX
- Insert into an external database using ajax and php : POST 500 (Internal Server Error)
Popular # Hahtags
Popular Questions
- How do I undo the most recent local commits in Git?
- How can I remove a specific item from an array in JavaScript?
- How do I delete a Git branch locally and remotely?
- Find all files containing a specific text (string) on Linux?
- How do I revert a Git repository to a previous commit?
- How do I create an HTML button that acts like a link?
- How do I check out a remote Git branch?
- How do I force "git pull" to overwrite local files?
- How do I list all files of a directory?
- How to check whether a string contains a substring in JavaScript?
- How do I redirect to another webpage?
- How can I iterate over rows in a Pandas DataFrame?
- How do I convert a String to an int in Java?
- Does Python have a string 'contains' substring method?
- How do I check if a string contains a specific word?
a bit late perhaps, but a postman collection is in a way showing the customer what API endpoints there are, and how to use them, but I think the customer was referring to some documentation like: https://www.openapis.org/ or https://swagger.io/ Then you create a yaml file according to the specified format, and it will result in a documentation page like this: https://petstore.swagger.io/