Where is API documentation?

[beigirad]

I didn't find API document in website or in readme files.

Could you add mention them in readme files?

[sbabashahi]

@beigirad did you mean something like https://api.jobguy.work/swagger/ ?

[beigirad]

Yes. Thanks.

[sbabashahi]

Could someone add link of swagger to read me file, it would be great to add description about using it.

[lmn3x]

hi. what kinda description about usage you mean??

[sbabashahi]

@lmn3x Like how to get token and use it for autorization

[lmn3x]

got it, but, current api doesn't need authorization ,right? i mean even after we get the token, there is no endpoint require token.

[sbabashahi]

@lmn3x I think your answer is the difference between these 2 images:

Public:

Authorized:

Am I right?

[lmn3x]

dammm..now i got the reason to do this :laughing:

[lmn3x]

i have 2 question tho..

1. English version is enough?
2. it should be in separated file?
3. should it include screenshots?? or just curl request and stuff?

[sbabashahi]

There are 3 questions :))

1. yes english is enough
2. adding it to readme is fine
3. try to add as details and descriptions as you can. think about it as someone has no clue and from here he/she wants to start.

[lmn3x]

so should i add screenshots?

[sbabashahi]

@lmn3x Sure

[lmn3x]

@lmn3x I think your answer is the difference between these 2 images:

Public:

Authorized:

Am I right?

a normal user don't access to this, right?

[lmn3x]

cuz after i authorize with token, i got the same public endpoints

[sbabashahi]

@lmn3x yes, there are multi levels of Access

[lmn3x]

ok i got it.. this is my first github collaboration, sorry if i ask too many questions :)