search

strohne / Facepager

Facepager was made for fetching public available data from YouTube, Twitter and other websites on the basis of APIs and webscraping.
https://github.com/strohne/Facepager/releases
506 stars 198 forks source link

API Documentation and Pattern System #15

Closed dorvak closed 5 years ago

dorvak commented 11 years ago

So wie hier könnte man die API-Dokumente automatisch in die Tabs einbauen und mögliche Parameter direkt mitliefern. Entweder man benutzt der JSON-Datei im Hintergrund oder man parsed direkt aus der API-Dokumentation. Müsste man für Facebook analog machen. Wenn man einen Parser baut, dann sogar direkt als eigenes kleines Guthub-Projekt: "Faceparser" :D

Gibt es eine API für API-Dokumentationen?

dorvak commented 10 years ago

Implemented a simple, tool-tip based API-Documentation for the Twitter-Tab based on a json-document with the API-Descriptions, parsed from the twitter API-Documentantion. Displaying the Information in a another widget might be a better solution than a tooltip. Just a quick idea so far ..

strohne commented 10 years ago

Very cool!

dorvak commented 10 years ago

I'll inbclude more options and automated parameter-suggestion in the future. See https://github.com/fsharp/FSharp.Data/issues/94 for API-Doc-Services which provide structured API-Info. quite cool!

dorvak commented 10 years ago

Patterns-suggestions are implemented for Twitter (needs optimazitation and error checking, but works so far)

dorvak commented 10 years ago

ToolTips for the dict/JSON-Viewer Keys based on https://dev.twitter.com/docs/platform-objects (or the respective Facebook-API-Documention:

strohne commented 7 years ago

I think we should use swagger (or similar) for this feature, see http://nordicapis.com/top-specification-formats-for-rest-apis/

What I don't know: is there a repository of swagger descriptions of twitter/facebook etc. apis?

strohne commented 7 years ago

Well, there is a repo: https://github.com/api-stack/api-stack

dorvak commented 7 years ago

I used swagger in a couple of projects, really advise to use swagger. Afaik there is no swaggerfile for FB or twitter

strohne commented 5 years ago

Migrated from our proprietary format to OpenAPI / Swagger. In addition, there is a window to show the API reference. For now we have only incomplete OpenAPI files in the master branch (only one example for Facebook). I will extend this in the next weeks.

strohne commented 5 years ago

I close this issue, feature is ready in the latest pre-release (version 4.0.0).