APIs & Use Case
Let's understand APIs with different scenarios, below are the sequence of scenarios:-
- 1.User (GET)
- 2.Asset (PUT)
• User(GET): You can fetch the user details with this API. UID is a unique key identifier in response this user UID helps to get spaces and makes other rest calls.
Request
Response
- Resource Path:
user
- HTTP Method:
GET
- Endpoint URL:
https://xxx.gitbook.com/v1/user

200: OK
🔰

{
"root": {
"baseDomain": "aatrey882",
"kind": "user",
"title": "AashishAtrey",
"uid": "edvwqJPyf5bKsCuz8Kqm4m8CZ1l2"
}
}
- Asset(PUT) Insert new assets in space.
Request
Response
- Resource Path:
spaces/:spaceID/content/assets
- HTTP Method:
PUT
- Endpoint URL:
https://xxx.gitbook.com/v1/spaces/:spaceID/content/assets
- Path Parameters: :
spaceID
To pass an attachment you need to convert file into base64 and then pass over HTTPS.

Request Body
200: OK
🔰
Returns the ID of the updated revision.
{"revision":"-MTMi9MgKuxSwZCV0bbH"}
I have covered 2 cases only there but you can fork my
GitHub
repository there you will find all scenarios that got integrated with ServiceNow.Conclusion:-
Overall GitBook is very cool but I feel that it lags some features
- 1.Themes customization should be available.
- 2.Compatible with .xlsx, .ppt, etc extensions as well.
- 3.Assets should get included on the page as of now it's in revision mode only.
Pros:
- Custom Domain
- Easy to configure APIs
Last modified 1yr ago