pfsense-api icon indicating copy to clipboard operation
pfsense-api copied to clipboard

Is there any recommended api client?

Open IonicaBizau opened this issue 4 years ago • 3 comments

Is there a recommended API client you would suggest? I work more with Node.js, but could not find any client for Node.js. Is there any page with the client libraries connecting to the API?

Thank you for the wonderful package!

IonicaBizau avatar Oct 11 '21 07:10 IonicaBizau

Hey!

This is a great question. I'm actually not aware of any client libraries for this package as of yet. I'm sure others have created such a thing, but I'm unsure if those are publicly available or maybe just specific to their use cases. My original hope was to one day release an official Python API client but the package alone has kept me very busy so I'm not sure how realistic that would be. At least in the near future.

I'd love to keep this conversation open with the community however. If anyone has created a client library (for any language) feel free to comment a link. I'd be more than happy to add a section in the documentation accrediting others' client libraries and possibly even contributing towards those projects myself. This may also be a good first project for anyone wanting to get started with open-source.

Thanks!

jaredhendrickson13 avatar Oct 11 '21 19:10 jaredhendrickson13

I'm starting to write one here https://github.com/yaleman/pfsense-api-client

yaleman avatar Jan 24 '22 11:01 yaleman

Update on this. v1.4.0 will make the switch to Swagger/OpenAPI for documentation and structure. This will also include the ability for auto-generated API clients in your desired language.

jaredhendrickson13 avatar Apr 22 '22 02:04 jaredhendrickson13