samthedeer 3 years{"ops":[{"insert":"I was looking through your site to find some docs on your API as I have users that want to be able to list cards from their decks that they have built here (people really love your builder). But I find that you are not willing to create a public api with documentation.\n\nThis is really poor form. I am certain that all most every single part of this project is built off of open source software. It would take so little time to have a subset of your internal APIs documented and largely static. \n\nYou should really consider giving back to the open source community when that community provides so much free stuff.\n\n/rant \n"}]}
0
michael(Alpha User)
3 years{"ops":[{"insert":"You say that we're not willing to create public API docs, that's not entirely true. It's not really that we're not willing to do so, it's more that our users have not really asked for that, so we haven't spent any time on it.\n\nYou're more than welcome to use our API for whatever you want (just know that you might hit our rate limiter if you hit it too hard). The deck endpoint in particular doesn't really change all that much so you're welcome to use it.\n\nThe main reason we don't provide API docs is because guaranteeing commitment to keeping them up to date with how frequently we make changes to Archidekt. Because it's only the two of us working on the sitem, it doesn't seem like a good use of our time to be 100% certain that we have correct API docs. We don't even have API docs for ourselves currently (I know shame on us 🤣), we just read through the source code when we want to understand what something is doing. \n\nThe real issue is the maintenance of docs, the rapidness of changes made, and guaranteeing a standard. With how quickly we make changes, needing to be beholden to a provided standard, and needing to make sure that the docs 100% match what's happening with our API would slow down development, which isn't really something we want to do (though again, if users were asking for it, we'd be happy to oblige).\n\nIf more users were asking for docs, we'd be extremely happy to spend time creating, and maintaining them. But as it stands, users generally prefer us spend our time improving the site and adding new features. \n\nIf you want us to, I'd be more than happy to throw that up Open API Docs onto our Feature Voting forum to see if it gets any traction! I'm just pretty confident that it'll just hang out there without much user interest. \n\nAlso as an aside, we're always happy to help answer questions if you're doing something with our API. Most of what you'd need I imagine could be gotten by looking at the requests being sent by the browser on decks being loaded and copying out the curl. \n"}]}
1
